符合性
版本引入了: ODBC 1.0 标准符合性: ODBC
摘要
SQLProcedures返回的特定数据源中存储的过程名称的列表。 过程是用于描述一个通用术语可执行对象,或已命名的实体,可以使用输入和输出参数进行调用。 有关过程的详细信息,请参阅过程。
语法
SQLRETURN SQLProcedures(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3);
参数
StatementHandle
[输入]语句句柄。
CatalogName
[输入]过程目录。 如果驱动程序支持目录有关的某些表而不是其他人,例如当驱动程序检索数据从不同 Dbms,空字符串 ("") 表示没有目录的那些表。 CatalogName不能包含字符串的搜索模式。
如果 SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE, CatalogName视为标识符和其大小写并不重要。 SQL_FALSE,若是CatalogName是普通参数; 按字面意思,处理和其大小写很重要。 有关详细信息,请参阅中目录函数的自变量。
NameLength1
[输入]以字符为单位的长度 *CatalogName。
SchemaName
[输入]过程架构名称的字符串搜索模式。 如果驱动程序支持的架构,对于一些过程,但对于其他操作系统,例如当驱动程序检索数据从不同 Dbms,空字符串 ("") 表示不具有架构的这些过程。
如果 SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE, SchemaName视为标识符和其大小写并不重要。 SQL_FALSE,若是SchemaName是模式值自变量; 按字面意思,处理和其大小写很重要。
NameLength2
[输入]以字符为单位的长度 *SchemaName。
ProcName
[输入]过程名称的字符串搜索模式。
如果 SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE, ProcName视为标识符和其大小写并不重要。 SQL_FALSE,若是ProcName是模式值自变量; 按字面意思,处理和其大小写很重要。
NameLength3
[输入]以字符为单位的长度 *ProcName。
返回
SQL_SUCCESS、 SQL_SUCCESS_WITH_INFO、 SQL_STILL_EXECUTING、 SQL_ERROR 或 SQL_INVALID_HANDLE。
诊断
当SQLProcedures返回 SQL_ERROR 或 SQL_SUCCESS_WITH_INFO,关联的 SQLSTATE 值可以通过调用来获取SQLGetDiagRec与HandleType的 SQL_HANDLE_STMT 和一个处理的StatementHandle。 下表列出了通常返回的 SQLSTATE 值SQLProcedures ,并解释了此函数; 每个上下文中的表示法"(数据挖掘)"之前 SQLSTATEs 返回由驱动程序管理器的说明。 与每个 SQLSTATE 值关联的返回代码是 SQL_ERROR,除非另有说明。
| SQLSTATE | 错误 | Description |
|---|---|---|
| 01000 | 常规警告 | 特定于驱动程序的信息性消息。 (函数返回 SQL_SUCCESS_WITH_INFO。) |
| 08S01 | 通讯链接失败 | 该驱动程序和驱动程序已连接到数据源之间的通信链接失败之前函数已完成处理。 |
| 24000 | 游标状态无效 | 在打开游标的StatementHandle,并SQLFetch或SQLFetchScroll已调用一样。 如果此错误返回由驱动程序管理器SQLFetch或SQLFetchScroll未返回 SQL_NO_DATA,和如果驱动程序返回SQLFetch或SQLFetchScroll已返回 sql_no_data 为止。 在打开游标的StatementHandle,但SQLFetch或SQLFetchScroll尚未调用。 |
| 40001 | 序列化失败 | 事务已回滚,由于其他事务与资源死锁。 |
| 40003 | 语句完成情况未知 | 此函数中,在执行期间失败关联的连接,无法确定事务的状态。 |
| HY000 | 常规错误 | 有关其中没有任何特定的 SQLSTATE 和为其定义任何特定于实现的 SQLSTATE 出错。 返回的错误消息SQLGetDiagRec中 *MessageText缓冲区描述错误以及其原因。 |
| HY001 | 内存分配错误 | 该驱动程序无法分配支持执行或完成该函数所需的内存。 |
| HY008 | 操作已取消 | 异步处理的已启用StatementHandle。 调用该函数,和之前执行完毕SQLCancel或SQLCancelHandle上调用了StatementHandle。 然后在再次调用该函数StatementHandle。 调用该函数,和之前执行完毕SQLCancel或SQLCancelHandle上调用了StatementHandle来自不同线程中多线程应用程序。 |
| HY009 | 使用空指针无效 | SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE, CatalogName参数为 null 指针和 SQL_CATALOG_NAME信息类型支持目录名称返回。 (DM) SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE,并SchemaName或ProcName参数是空指针。 |
| HY010 | 函数序列错误 | (DM) 为与之关联的连接句柄调用以异步方式执行的函数StatementHandle。 此异步函数仍在执行时调用此函数。 (数据挖掘) SQLExecute, SQLExecDirect,或SQLMoreResults曾为StatementHandle和返回 SQL_PARAM_DATA_可用。 数据已检索到的所有经过流处理参数之前调用此函数。 (DM) 的调用以异步方式执行的函数 (不是此类似) StatementHandle和仍在执行时调用此函数。 (数据挖掘) SQLExecute, SQLExecDirect, SQLBulkOperations,或者SQLSetPos曾为StatementHandle和返回 SQL_NEED_DATA。 数据已发送的所有执行时数据参数或列之前调用此函数。 |
| HY013 | 内存管理错误 | 无法处理函数调用,因为基础内存对象无法访问,可能是由于内存不足的情况。 |
| HY090 | 字符串或缓冲区长度无效 | (DM) 之一的名称长度参数值小于 0 但不是等于 SQL_NTS。 名称长度参数之一的值超出相应名称的最大长度值。 |
| HY117 | 由于未知的事务状态而挂起连接。 仅断开连接,并允许使用只读的函数。 | (DM) 有关挂起状态的详细信息,请参阅SQLEndTran 函数。 |
| HYC00 | 未实现的可选功能 | 指定过程目录,并在驱动程序或数据源不支持目录。 指定过程的架构,并在驱动程序或数据源不支持架构。 为过程架构或过程名称,指定字符串的搜索模式和数据源不支持的一个或多个这些参数的搜索模式。 驱动程序或数据源不支持 SQL_ATTR_CONCURRENCY 和 SQL_ATTR_CURSOR_TYPE 语句属性的当前设置的组合。 SQL_ATTR_USE_BOOKMARKS 语句属性设置为 SQL_UB_VARIABLE,并且 SQL_ATTR_CURSOR_TYPE 语句属性设置为游标类型,该驱动程序不支持书签。 |
| HYT00 | 超时时间已到 | 查询超时期限过期之前请求的结果集返回的数据源。 通过设置超时期限SQLSetStmtAttr,SQL_ATTR_QUERY_TIMEOUT。 |
| HYT01 | 连接超时时间已到 | 连接超时期限过期之前的数据源响应此请求。 通过设置连接超时期SQLSetConnectAttr,SQL_ATTR_CONNECTION_TIMEOUT。 |
| IM001 | 驱动程序不支持此函数 | (DM) 驱动程序与相关联StatementHandle不支持此函数。 |
| IM017 | 轮询异步通知模式中禁用 | 只要使用通知模型,将禁用轮询。 |
| IM018 | SQLCompleteAsync尚未调用以完成此句柄上以前的异步操作。 | 如果句柄上的上一个函数调用返回 SQL_STILL_EXECUTING,如果启用通知模式,则SQLCompleteAsync必须要对其进行后期处理并完成该操作的句柄上调用。 |
注释
SQLProcedures列出了所请求的范围中的所有过程。 用户可能会或可能没有执行任何这些过程的权限。 若要检查辅助功能,应用程序可以调用SQLGetInfo并检查 SQL_ACCESSIBLE_PROCEDURES 信息值。 否则,应用程序必须能够处理的情况下,其中用户选择不能执行的过程。 有关可以如何使用此信息的信息,请参阅过程。
Note:
有关常规使用、 参数以及 ODBC 目录函数返回的数据的详细信息,请参阅目录函数。
SQLProcedures以按 PROCEDURE_CAT、 PROCEDURE_SCHEMA 和 PROCEDURE_NAME 标准结果集的形式返回结果。
Note:
SQLProcedures可能不会返回所有过程。 应用程序可以使用任何有效的过程,而不考虑是否返回由SQLProcedures。
以下各列已重命名为 ODBC 3 .x。 列名称更改不会影响后向兼容性,因为应用程序将绑定的列号。
| ODBC 2.0 列 | ODBC 3 .x列 |
|---|---|
| PROCEDURE_QUALIFIER | PROCEDURE_CAT |
| 过程 _OWNER | 过程 _SCHEM |
若要确定 PROCEDURE_CAT、 PROCEDURE_SCHEM 和 PROCEDURE_NAME 列的实际长度,应用程序可以调用SQLGetInfo使用 SQL_MAX_CATALOG_NAME_LEN、 SQL_MAX_SCHEMA_NAME_LEN 和 SQL_MAX_PROCEDURE_NAME_LEN 选项。
下表列出了在结果集中的列。 列 8 (PROCEDURE_TYPE) 之外的其他列可以定义由驱动程序。 应用程序应获得访问驱动程序特定列的结果集末尾的倒计时,而不是指定显式的序号位置。 有关详细信息,请参阅目录函数返回数据。
| 列名 | 列号 | 数据类型 | 注释 |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | 过程目录标识符;如果不适用于数据源为 NULL。 如果驱动程序支持目录对于一些过程,但对于其他操作系统,如当驱动程序检索数据时从不同 Dbms,它返回空字符串 ("") 对于这些没有目录的过程。 |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | 过程架构标识符;如果不适用于数据源为 NULL。 如果驱动程序支持架构对于一些过程,但对于其他操作系统,如当驱动程序检索数据时从不同 Dbms,它返回空字符串 ("") 对于这些没有架构的过程。 |
| 过程名称 (ODBC 2.0) | 3 | Varchar 不为 NULL | 过程标识符。 |
| NUM_INPUT_PARAMS (ODBC 2.0) | 4 | N/A | 保留供将来使用。 应用程序不应依赖这些结果列中返回的数据。 |
| NUM_OUTPUT_PARAMS (ODBC 2.0) | 5 | N/A | 保留供将来使用。 应用程序不应依赖这些结果列中返回的数据。 |
| NUM_RESULT_SETS (ODBC 2.0) | 6 | N/A | 保留供将来使用。 应用程序不应依赖这些结果列中返回的数据。 |
| 备注 (ODBC 2.0) | 7 | Varchar | 对过程的说明。 |
| PROCEDURE_TYPE (ODBC 2.0) | 8 | Smallint | 定义过程类型: SQL_PT_UNKNOWN: 不能确定是否该过程返回值。 SQL_PT_PROCEDURE: 返回的对象是过程;也就是说,它没有返回值。 SQL_PT_FUNCTION: 返回的对象是一个函数;也就是说,它具有返回值。 |
SchemaName并ProcName参数接受搜索模式。 有关有效的搜索模式的详细信息,请参阅模式值自变量。
代码示例
请参阅过程调用。
相关函数
| 有关信息 | 请参阅 |
|---|---|
| 将缓冲区绑定到结果集中的列 | SQLBindCol 函数 |
| 取消语句处理 | SQLCancel 函数 |
| 提取单个行或仅向前方向中的数据块 | SQLFetch 函数 |
| 提取的数据块或滚动浏览结果集 | SQLFetchScroll 函数 |
| 返回有关驱动程序或数据源的信息 | SQLGetInfo 函数 |
| 返回参数和结果集列的过程 | SQLProcedureColumns 函数 |
| 用于调用存储的过程的语法 | 执行语句 |
请参阅
历史资料。此文对应 2018-11-30 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 MightyPen)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
