SQLProcedureColumns Function（SQLProcedureColumns 函数）
一致性
引入的版本：ODBC 1.0 标准合规性：ODBC
摘要
SQLProcedureColumns 返回输入和输出参数的列表，以及构成指定过程的结果集的列。 驱动程序以指定语句上的结果集的形式返回信息。
语法
SQLRETURN SQLProcedureColumns(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3,
SQLCHAR * ColumnName,
SQLSMALLINT NameLength4);
参数
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 的长度（以字符为单位）。
ColumnName
[输入]列名的字符串搜索模式。
如果 SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE， 则 ColumnName 被视为标识符，其大小写并不重要。 如果SQL_FALSE， 则 ColumnName 是模式值参数;它按字面处理，其大小写很重要。
NameLength4
[输入]*ColumnName 的长度（以字符为单位）。
返回
SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_STILL_EXECUTING、SQL_ERROR或SQL_INVALID_HANDLE。
诊断
当 SQLProcedureColumns 返回SQL_ERROR或SQL_SUCCESS_WITH_INFO时，可以通过使用 handleType 为 SQL_HANDLE_STMT 和 Handle of StatementHandle 调用 SQLGetDiagRec 来获取关联的 SQLSTATE 值。 下表列出了 SQLProcedureColumns 通常返回的 SQLSTATE 值，并对此函数的上下文中的每个值进行了说明：表示法“ (DM) ”位于驱动程序管理器返回的 SQLSTATE 说明之前。 与每个 SQLSTATE 值关联的返回代码SQL_ERROR，除非另有说明。
| SQLSTATE | 错误 | 说明 |
|---|---|---|
| 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。 SQLError 在 *MessageText 缓冲区中返回的错误消息描述了错误及其原因。 |
| HY001 | 内存分配错误 | 驱动程序无法分配支持执行或完成函数所需的内存。 |
| HY008 | 操作已取消 | 已为 StatementHandle 启用异步处理。 调用了函数，在它完成执行之前，在 StatementHandle 上调用了 SQLCancel 或 SQLCancelHandle。 然后，在 StatementHandle 上再次调用函数。 函数已调用，在它完成执行之前，在 StatementHandle 上从多线程应用程序中的不同线程调用 SQLCancel 或 SQLCancelHandle。 |
| HY009 | null 指针的使用无效 | SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE， CatalogName 参数为 null 指针， infoType SQL_CATALOG_NAME 返回目录名称受支持。 (DM) SQL_ATTR_METADATA_ID 语句属性设置为 SQL_TRUE， 并且 SchemaName、 ProcName 或 ColumnName 参数为 null 指针。 |
| HY010 | 函数序列错误 | (DM) 为与 StatementHandle 关联的连接句柄调用了异步执行的函数。 调用 SQLProcedureColumns 函数时，此 aynschronous 函数仍在执行。 (DM) SQLExecute、 SQLExecDirect 或 SQLMoreResults 已为 StatementHandle 调用并返回SQL_PARAM_DATA_AVAILABLE。 此函数是在检索所有流参数的数据之前调用的。 (DM) 为 StatementHandle 调用了异步执行的函数， (不是此函数) ，在调用此函数时仍在执行。 (DM) SQLExecute、 SQLExecDirect、 SQLBulkOperations 或 SQLSetPos 已为 StatementHandle 调用，并返回SQL_NEED_DATA。 在针对所有数据执行参数或列发送数据之前调用了此函数。 |
| 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 以执行后期处理并完成操作。 |
注释
此函数通常在语句执行之前用于检索有关过程参数的信息，以及构成过程返回的结果集的列（如果有）。 有关详细信息，请参阅过程。
注意
SQLProcedureColumns 可能不会返回过程使用的所有列。 例如，驱动程序可能仅返回有关过程使用的参数的信息，而不返回它生成的结果集中的列。
SchemaName、ProcName 和 ColumnName 参数接受搜索模式。 有关有效搜索模式的详细信息，请参阅 模式值参数。
注意
有关 ODBC 目录函数的常规用法、参数和返回数据的详细信息，请参阅 目录函数。
SQLProcedureColumns 将结果作为标准结果集返回，按PROCEDURE_CAT、PROCEDURE_SCHEM、PROCEDURE_NAME和COLUMN_TYPE排序。 按以下顺序为每个过程返回列名称：返回值的名称、过程调用中每个参数的名称 (按调用顺序) ，然后过程返回的结果集中每个列的名称 (按列顺序) 。
应用程序应相对于结果集末尾绑定特定于驱动程序的列。 有关详细信息，请参阅 目录函数返回的数据。
若要确定PROCEDURE_CAT、PROCEDURE_SCHEM、PROCEDURE_NAME和COLUMN_NAME列的实际长度，应用程序可以使用SQL_MAX_CATALOG_NAME_LEN、SQL_MAX_SCHEMA_NAME_LEN、SQL_MAX_PROCEDURE_NAME_LEN和SQL_MAX_COLUMN_NAME_LEN选项调用 SQLGetInfo 。
以下列已重命名为 ODBC 3。x. 列名称更改不会影响向后兼容性，因为应用程序按列号绑定。
| ODBC 2.0 列 | ODBC 3。x 列 |
|---|---|
| PROCEDURE_QUALIFIER | PROCEDURE_CAT |
| 过程_OWNER | PROCEDURE_SCHEM |
| PRECISION | COLUMN_SIZE |
| LENGTH | BUFFER_LENGTH |
| SCALE | DECIMAL_DIGITS |
| RADIX | NUM_PREC_RADIX |
以下列已添加到 ODBC 3 的 SQLProcedureColumns 返回的结果集中。x：
COLUMN_DEF
DATETIME_CODE
CHAR_OCTET_LENGTH
ORDINAL_POSITION
IS_NULLABLE
下表列出了结果集中的列。 驱动程序可以定义第 19 列 (IS_NULLABLE) 以外的其他列。 应用程序应通过从结果集末尾倒计时而不是指定显式序号位置来获取对特定于驱动程序的列的访问权限。 有关详细信息，请参阅 目录函数返回的数据。
| 列名称 | 列号 | 数据类型 | 注释 |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | 过程目录名称;如果不适用于数据源，则为 NULL。 如果驱动程序支持某些过程的目录，但不支持其他过程的目录，例如，当驱动程序从不同的 DBMS 检索数据时，它将为没有目录的过程返回空字符串 (“”) 。 |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | 过程架构名称;如果不适用于数据源，则为 NULL。 如果驱动程序支持某些过程的架构，但对其他过程不支持架构，例如，当驱动程序从不同的 DBMS 检索数据时，它将为没有架构的过程返回空字符串 (“”) 。 |
| PROCEDURE_NAME (ODBC 2.0) | 3 | Varchar 不为 NULL | 过程名。 对于没有名称的过程，返回一个空字符串。 |
| COLUMN_NAME (ODBC 2.0) | 4 | Varchar 不为 NULL | 过程列名。 驱动程序为没有名称的过程列返回空字符串。 |
| COLUMN_TYPE (ODBC 2.0) | 5 | Smallint（非 NULL） | 将过程列定义为参数或结果集列： SQL_PARAM_TYPE_UNKNOWN：过程列是类型未知的参数。 (ODBC 1.0) SQL_PARAM_INPUT：过程列是输入参数。 (ODBC 1.0) SQL_PARAM_INPUT_OUTPUT：过程列是输入/输出参数。 (ODBC 1.0) SQL_PARAM_OUTPUT：过程列是输出参数。 (ODBC 2.0) SQL_RETURN_VALUE：过程列是过程的返回值。 (ODBC 2.0) SQL_RESULT_COL：过程列是结果集列。 (ODBC 1.0) |
| DATA_TYPE (ODBC 2.0) | 6 | Smallint（非 NULL） | SQL 数据类型。 这可以是 ODBC SQL 数据类型或特定于驱动程序的 SQL 数据类型。 对于 datetime 和 interval 数据类型，此列返回简洁的数据类型 (例如，SQL_TYPE_TIME或SQL_INTERVAL_YEAR_TO_MONTH) 。 有关有效 ODBC SQL 数据类型的列表，请参阅附录 D：数据类型中的 SQL 数据类型。 有关特定于驱动程序的 SQL 数据类型的信息，请参阅驱动程序的文档。 |
| TYPE_NAME (ODBC 2.0) | 7 | Varchar 不为 NULL | 数据源相关的数据类型名称;例如，“CHAR”、“VARCHAR”、“MONEY”、“LONG VARBINARY”或“CHAR ( ) FOR BIT DATA”。 |
| COLUMN_SIZE (ODBC 2.0) | 8 | Integer | 数据源上过程列的列大小。 对于列大小不适用的数据类型，返回 NULL。 有关精度的详细信息，请参阅附录 D：数据类型中的 列大小、十进制数字、传输八进制数长度和显示大小 。 |
| BUFFER_LENGTH (ODBC 2.0) | 9 | Integer | 如果指定了SQL_C_DEFAULT，则为 SQLGetData 或 SQLFetch 操作上传输的数据的长度（以字节为单位）。 对于数值数据，此大小可能与存储在数据源上的数据的大小不同。 有关详细信息，请参阅附录 D：数据类型中的 列大小、十进制数字、传输八进制数长度和显示大小。 |
| DECIMAL_DIGITS (ODBC 2.0) | 10 | Smallint | 数据源上过程列的十进制数字。 对于十进制数字不适用的数据类型，返回 NULL。 有关十进制数字的详细信息，请参阅附录 D：数据类型中的 列大小、十进制数字、传输八进制数长度和显示大小。 |
| NUM_PREC_RADIX (ODBC 2.0) | 11 | Smallint | 对于数值数据类型，可以是 10 或 2。 如果为 10，则COLUMN_SIZE 和 DECIMAL_DIGITS中的值提供列允许的小数位数。 例如，DECIMAL (12，5) 列将返回 10 的NUM_PREC_RADIX，COLUMN_SIZE为 12，DECIMAL_DIGITS为 5;FLOAT 列可以返回 10 的NUM_PREC_RADIX，COLUMN_SIZE为 15，DECIMAL_DIGITS NULL。 如果为 2，则COLUMN_SIZE 和 DECIMAL_DIGITS中的值提供列中允许的位数。 例如，FLOAT 列可以返回 2 的NUM_PREC_RADIX、53 的COLUMN_SIZE和 NULL DECIMAL_DIGITS。 对于不适用NUM_PREC_RADIX的数据类型，返回 NULL。 |
| 可为 NULL (ODBC 2.0) | 12 | Smallint（非 NULL） | 过程列是否接受 NULL 值： SQL_NO_NULLS：过程列不接受 NULL 值。 SQL_NULLABLE：过程列接受 NULL 值。 SQL_NULLABLE_UNKNOWN：不知道过程列是否接受 NULL 值。 |
| 备注 (ODBC 2.0) | 13 | Varchar | 过程列的说明。 |
| COLUMN_DEF (ODBC 3.0) | 14 | Varchar | 列的默认值。 如果将 NULL 指定为默认值，则此列为单词 NULL，而不是用引号引起来。 如果在不截断的情况下无法表示默认值，则此列将包含 TRUNCATED，且不带单引号。 如果未指定默认值，则此列为 NULL。 COLUMN_DEF 的值可用于生成新的列定义，但包含值 TRUNCATED 时除外。 |
| SQL_DATA_TYPE (ODBC 3.0) | 15 | Smallint（非 NULL） | 出现在描述符的SQL_DESC_TYPE字段中的 SQL 数据类型的值。 此列与DATA_TYPE列相同，但 datetime 和 interval 数据类型除外。 对于 datetime 和 interval 数据类型，结果集中SQL_DATA_TYPE字段将返回SQL_INTERVAL或SQL_DATETIME，SQL_DATETIME_SUB字段将返回特定间隔或日期时间数据类型的子代码。 (请参阅 附录 D：Data Types.) |
| SQL_DATETIME_SUB (ODBC 3.0) | 16 | Smallint | datetime 和 interval 数据类型的子类型代码。 对于其他数据类型，此列返回 NULL。 |
| CHAR_OCTET_LENGTH (ODBC 3.0) | 17 | Integer | 字符或二进制数据类型列的最大长度（以字节为单位）。 对于所有其他数据类型，此列返回 NULL。 |
| ORDINAL_POSITION (ODBC 3.0) | 18 | Integer（非 NULL） | 对于输入和输出参数，参数在过程定义中的序号位置 (递增参数顺序，从 1) 开始。 对于返回值 (如果有任何) ，则返回 0。 对于结果集列，列在结果集中的序号位置，结果集中的第一列为数字 1。 如果有多个结果集，则以特定于驱动程序的方式返回列序号位置。 |
| IS_NULLABLE (ODBC 3.0) | 19 | Varchar | 如果列不包含 NULL，则为“否”。 如果列可以包含 NULL，则为 “YES”。 如果为 Null 性为未知，该列将返回零长度字符串。 根据 ISO 规则确定为 Null 性。 遵从 ISO SQL 标准的 DBMS 不能返回空字符串。 该列返回的值与 NULLABLE 列返回的值不同。 (请参阅 NULLABLE 列的说明。) |
代码示例
请参阅 过程调用。
相关函数
| 有关以下方面的信息 | 请参阅 |
|---|---|
| 将缓冲区绑定到结果集中的列 | SQLBindCol 函数 |
| 取消语句处理 | SQLCancel 函数 |
| 以仅向前方向提取单个行或数据块 | SQLFetch 函数 |
| 提取数据块或滚动浏览结果集 | SQLFetchScroll Function（SQLFetchScroll 函数） |
| 返回数据源中的过程列表 | SQLProcedures 函数 |