表值参数描述符字段

适用于：SQL ServerAzure SQL 数据库Azure SQL 托管实例Azure Synapse AnalyticsAnalytics Platform System (PDW)

对表值参数的支持包括 ODBC 应用程序参数描述符中新的特定于SQL Server字段， (APD) 和实现参数描述符 (IPD) 。

备注

名称	位置	类型	说明
SQL_CA_SS_TYPE_NAME	IPD	SQLTCHAR*	表值参数的服务器类型名称。 在调用 SQLBindParameter 时指定表值参数类型名称时，必须始终将其指定为 Unicode 值，即使在构建为 ANSI 应用程序的应用程序中也是如此。 用于参数 StrLen_or_IndPtr 的值应为SQL_NTS或名称的字符串长度乘以 size of (WCHAR) 。 通过 SQLSetDescField 指定表值参数类型名称时，可以使用符合生成应用程序的方式的文本来指定该名称。 ODBC 驱动程序管理器将执行任何所需的 Unicode 转换。
SQL_CA_SS_TYPE_CATALOG_NAME（只读）	IPD	SQLTCHAR*	定义该类型的目录。
SQL_CA_SS_TYPE_SCHEMA_NAME	IPD	SQLTCHAR*	定义该类型的架构。

应用程序不得为表值参数设置 SQL_CA_SS_TYPE_CATALOG_NAME。 这样做将返回 SQL_ERROR，并记录包含 SQLSTATE = HY091 和消息“描述符字段标识符无效”的诊断记录。

如果将参数焦点设置为表值参数，则以下语句属性和描述符标头字段将应用于表值参数：

名称	位置	类型	说明
SQL_ATTR_PARAMSET_SIZE （这等同于 APD 中的 SQL_DESC_ARRAY_SIZE。）	APD	SQLUINTEGER	用于表值参数的缓冲区数组的数组大小。 这是缓冲区将容纳的最大行数或缓冲区的行数大小；表值参数值本身所具有的行数可能大于或小于缓冲区可以容纳的行数。 默认值为 1。 注意：如果将SQL_SOPT_SS_PARAM_FOCUS设置为默认值 0，则SQL_ATTR_PARAMSET_SIZE引用 语句并指定参数集的数目。 如果将 SQL_SOPT_SS_PARAM_FOCUS 设置为表值参数的序号，则它引用该表值参数，并为该表值参数指定每个参数集具有的行数。
SQL_ATTR_PARAM _BIND_TYPE	APD	SQLINTEGER	默认值是 SQL_PARAM_BIND_BY_COLUMN。 若要选择按行绑定，则该字段将设置为将要绑定到一组表值参数行的结构或缓冲区实例的长度。 此长度必须包括所有绑定列的空间以及结构或缓冲区的任何填充大小。 这将确保当绑定列的地址按指定长度递增时，结果将指向下一行中相同列的开头。 在 ANSI C 中使用 sizeof 运算符时，可以保证此行为。
SQL_ATTR_PARAM_BIND_OFFSET_PTR	APD	SQLINTEGER*	默认为 Null 指针。 如果该字段为非 Null，则驱动程序取消对该指针的引用，并将取消引用的值添加到描述符记录（SQL_DESC_DATA_PTR、SQL_DESC_INDICATOR_PTR 和 SQL_DESC_OCTET_LENGTH_PTR）中每个延迟的字段，然后使用新指针值访问数据值。

这些字段仅对表值参数有效，对于其他数据类型，将忽略它们。

SQL_CA_SS_TYPE_NAME 对于存储过程调用是可选项。 对于不是过程调用的 SQL 语句，则必须指定它，才能使服务器能够确定表值参数的类型。

如果类型名称是必需的，并且在不同于该存储过程的架构中定义了表值参数的表类型，则必须在实现参数描述符 (IPD) 中指定 SQL_CA_SS_TYPE_SCHEMA_NAME。 如果不这样，则服务器无法确定表值参数的类型。 调用 SQLExecute 或 SQLExecDirect 时，这将导致错误。 错误将包含 SQLSTATE= 07006 和消息“受限制的数据类型属性冲突”。

表值参数列可以使用按行或按列绑定。 默认为按列绑定。 通过设置 SQL_ATTR_PARAM_BIND_TYPE 和 SQL_ATTR_ PARAM_BIND_OFFSET_PTR，可以指定按行绑定。 这与对列和参数的按行绑定类似。

SQL_CA_SS_TYPE_CATALOG_NAME 和 SQL_CA_SS_TYPE_SCHEMA_NAME 还可以用于检索与 CLR 用户定义类型参数关联的目录和架构。 对于这些类型，它们是特定于类型的现有目录架构属性的替代项。

另请参阅

表值参数 (ODBC)