SQLProcedureColumnsSQLProcedureColumns

適用対象: yesSQL Server yesAzure SQL Database yesAzure Synapse Analytics (SQL DW) yesParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database yesAzure Synapse Analytics (SQL DW) yesParallel Data Warehouse

SQLProcedureColumnsは、すべての SQL ServerSQL Server ストアドプロシージャの戻り値の属性を報告する1行を返します。SQLProcedureColumns returns one row reporting the return value attributes of all SQL ServerSQL Server stored procedures.

SQLProcedureColumnsは、 CatalogNameSchemaNameProcName、またはColumnNameパラメーターの値が存在するかどうか SQL_SUCCESS 返します。SQLProcedureColumns returns SQL_SUCCESS whether or not values exist for CatalogName, SchemaName, ProcName, or ColumnName parameters. これらのパラメーターで無効な値が使用されている場合、 Sqlfetchは SQL_NO_DATA を返します。SQLFetch returns SQL_NO_DATA when invalid values are used in these parameters.

SQLProcedureColumnsは、静的サーバーカーソルで実行できます。SQLProcedureColumns can be executed on a static server cursor. 更新可能なカーソル (動的カーソルまたはキーセットカーソル) でSQLProcedureColumnsを実行しようとすると、カーソルの種類が変更されたことを示す SQL_SUCCESS_WITH_INFO が返されます。An attempt to execute SQLProcedureColumns on an updatable (dynamic or keyset) cursor will return SQL_SUCCESS_WITH_INFO indicating that the cursor type has been changed.

次の表に、結果セットによって返される列と、SQL ServerSQL Server Native Client ODBC ドライバーを使用してudtデータ型およびxmlデータ型を処理するように拡張された列を示します。The following table lists the columns returned by the result set and how they have been extended to handle the udt and xml data types through the SQL ServerSQL Server Native Client ODBC driver:

列名Column name [説明]Description
SS_UDT_CATALOG_NAMESS_UDT_CATALOG_NAME UDT (ユーザー定義型) を含むカタログの名前を返します。Returns the name of the catalog containing the UDT (user-defined type).
SS_UDT_SCHEMA_NAMESS_UDT_SCHEMA_NAME UDT を含むスキーマの名前を返します。Returns the name of the schema containing the UDT.
SS_UDT_ASSEMBLY_TYPE_NAMESS_UDT_ASSEMBLY_TYPE_NAME UDT のアセンブリ修飾名を返します。Returns the assembly-qualified name of the UDT.
SS_XML_SCHEMACOLLECTION_CATALOG_NAMESS_XML_SCHEMACOLLECTION_CATALOG_NAME XML スキーマ コレクション名が定義されているカタログの名前を返します。Returns the name of the catalog where an XML schema collection name is defined. カタログ名が見つからない場合は、この変数に空文字列が含まれます。If the catalog name cannot be found, then this variable contains an empty string.
SS_XML_SCHEMACOLLECTION_SCHEMA_NAMESS_XML_SCHEMACOLLECTION_SCHEMA_NAME XML スキーマ コレクション名が定義されているスキーマの名前を返します。Returns the name of the schema where an XML schema collection name is defined. スキーマ名が見つからない場合は、この変数に空文字列が含まれます。If the schema name cannot be found, then this variable contains an empty string.
SS_XML_SCHEMACOLLECTION_NAMESS_XML_SCHEMACOLLECTION_NAME XML スキーマ コレクションの名前を返します。Returns the name of an XML schema collection. 名前が見つからない場合は、この変数に空文字列が含まれます。If the name cannot be found, then this variable contains an empty string.

SQLProcedureColumns とテーブル値パラメーターSQLProcedureColumns and Table-Valued Parameters

SQLProcedureColumns は、CLR ユーザー定義型と同様の方法でテーブル値パラメーターを処理します。SQLProcedureColumns handles table-valued parameters in a manner similar to CLR user-defined types. テーブル値パラメーターに対して返される行では、列に次の値が設定されます。In rows returned for table-valued parameters, columns have the following values:

列名Column name 説明/値Description/value
DATA_TYPEDATA_TYPE SQL_SS_TABLESQL_SS_TABLE
TYPE_NAMETYPE_NAME テーブル値パラメーターのテーブル型の名前。The name of the table type for the table-valued parameter.
COLUMN_SIZECOLUMN_SIZE NULLNULL
BUFFER_LENGTHBUFFER_LENGTH 00
DECIMAL_DIGITSDECIMAL_DIGITS テーブル値パラメーターの列数。The number of columns in the table-valued parameter.
NUM_PREC_RADIXNUM_PREC_RADIX NULLNULL
NULLABLENULLABLE SQL_NULLABLESQL_NULLABLE
REMARKSREMARKS NULLNULL
COLUMN_DEFCOLUMN_DEF NULL。NULL. テーブル型には既定値がない場合があります。Table types might not have default values.
SQL_DATA_TYPESQL_DATA_TYPE SQL_SS_TABLESQL_SS_TABLE
SQL_DATEIME_SUBSQL_DATEIME_SUB NULLNULL
CHAR_OCTET_LENGTHCHAR_OCTET_LENGTH NULLNULL
IS_NULLABLEIS_NULLABLE "YES""YES"
SS_TYPE_CATALOG_NAMESS_TYPE_CATALOG_NAME テーブル型または CLR ユーザー定義型を含むカタログの名前を返します。Returns the name of the catalog that contains the table or CLR user-defined type.
SS_TYPE_SCHEMA_NAMESS_TYPE_SCHEMA_NAME テーブル型または CLR ユーザー定義型を含むスキーマの名前を返します。Returns the name of the schema that contains the table or CLR user-defined type.

SS_TYPE_CATALOG_NAME 列および SS_TYPE_SCHEMA_NAME 列は SQL Server 2008SQL Server 2008 以降のバージョンで利用可能であり、これらの列はそれぞれ、テーブル値パラメーターのカタログとスキーマを返します。The SS_TYPE_CATALOG_NAME and SS_TYPE_SCHEMA_NAME columns are available in SQL Server 2008SQL Server 2008 and later versions to return the catalog and schema, respectively, for table-valued parameters. テーブル値パラメーターに加え CLR ユーザー定義型パラメーターに対しても、これらの列が作成されますThese columns are populated for table-valued parameters, and also for CLR user-defined type parameters. (CLR ユーザー定義型パラメーターの既存のスキーマ列とカタログ列は、この追加機能の影響を受けません。(Existing schema and catalog columns for CLR user-defined type parameters are not affected by this additional functionality. これらの列は、旧バージョンとの互換性を維持するためにも作成されます)。They are also populated to maintain backward compatibility).

SS_TYPE_CATALOG_NAME および SS_TYPE_SCHEMA_NAME は、ODBC 仕様に準拠して、以前のバージョンの SQL ServerSQL Server で追加されたドライバー固有のすべての列の前、かつ ODBC 自体によって指定されるすべての列の後に作成されます。In conformance with the ODBC specification, SS_TYPE_CATALOG_NAME and SS_TYPE_SCHEMA_NAME appear before all driver-specific columns added in previous versions of SQL ServerSQL Server, and after all columns mandated by ODBC itself.

テーブル値パラメーターの詳細については、「テーブル値パラメーター (の)ODBC」を参照してください。For more information about table-valued parameters, see Table-Valued Parameters (ODBC).

SQLProcedureColumns による機能強化された日付と時刻のサポートSQLProcedureColumns Support for Enhanced Date and Time Features

日付型または時刻型に対して返される値については、「カタログメタデータ」を参照してください。For the values returned for date/time types, see Catalog Metadata.

一般的な情報については、「日付(と)時刻の機能強化 ODBC」を参照してください。For more general information, see Date and Time Improvements (ODBC).

SQLProcedureColumns による大きな CLR UDT のサポートSQLProcedureColumns Support for Large CLR UDTs

SQLProcedureColumnsは、大きな CLR ユーザー定義型 (udt) をサポートしています。SQLProcedureColumns supports large CLR user-defined types (UDTs). 詳細については、「 LARGE CLR ユーザー定義(型)ODBC」を参照してください。For more information, see Large CLR User-Defined Types (ODBC).

参照See Also

SQLProcedureColumns 関数 SQLProcedureColumns Function
ODBC API 実装の詳細ODBC API Implementation Details