SQLProcedureColumns 関数 (CLI) - プロシージャーの入出力パラメーター情報の取得

SQLRETURN SQLProcedureColumns(
             SQLHSTMT          StatementHandle,   /* hstmt */
             SQLCHAR           *CatalogName,      /* szProcCatalog */
             SQLSMALLINT       NameLength1,       /* cbProcCatalog */
             SQLCHAR           *SchemaName,       /* szProcSchema */
             SQLSMALLINT       NameLength2,       /* cbProcSchema */
             SQLCHAR           *ProcName,         /* szProcName */
             SQLSMALLINT       NameLength3,       /* cbProcName */
             SQLCHAR           *ColumnName,       /* szColumnName */
             SQLSMALLINT       NameLength4);      /* cbColumnName */

列 1  PROCEDURE_CAT (VARCHAR(128))

プロシージャー・カタログ名。このプロシージャーにカタログがない場合、この値は NULL になります。

列 2  PROCEDURE_SCHEM (VARCHAR(128))

PROCEDURE_NAME を含むスキーマの名前。DB2 for z/OS の SQLProcedureColumns() 結果セットの場合は NULL です。

列 3  PROCEDURE_NAME (VARCHAR(128))

プロシージャーの名前。

列 4  COLUMN_NAME (VARCHAR(128))

パラメーターの名前。

列 5  COLUMN_TYPE (SMALLINT 非 NULL)

この行に関連した情報のタイプを識別します。戻される値は以下のとおりです。

• SQL_PARAM_INPUT は入力パラメーターです。
• SQL_PARAM_INPUT_OUTPUT は入出力パラメーターです。
• SQL_PARAM_OUTPUT は出力パラメーターです。

ODBC 仕様で定義されていても戻されない値は以下のとおりです。

• SQL_PARAM_TYPE_UNKNOWN : パラメーター・タイプが不明です。
• SQL_RETURN_VALUE はプロシージャー列内のプロシージャーの戻り値です。
• SQL_RESULT_COL は、結果セット内の列です。

列 6  DATA_TYPE (SMALLINT 非 NULL)

SQL データ・タイプ。

列 7  TYPE_NAME (VARCHAR(128) 非 NULL)

DATA_TYPE に対応するデータ・タイプの名前を表す文字ストリング。

列 8  COLUMN_SIZE (INTEGER)

SQL ルーチン内の XML 引数の場合、(XML 引数には長さがないため) ゼロが戻されます。 しかし、カタログ式外部ルーチンの場合、XML パラメーターは XML AS CLOB(n) として宣言されます。この場合、COLUMN_SIZE はカタログされた長さ、n です。

DATA_TYPE 列の値が文字ストリングまたはバイナリー・ストリングを示す場合、この列には SQLCHAR または SQLWCHAR エレメント数で表記した最大長が入れられます。DATA_TYPE 列の値が GRAPHIC (DBCS) ストリングの場合、COLUMN_SIZE はパラメーターの 2 バイトの SQLCHAR エレメントまたは SQLWCHAR エレメントの数になります。

日付、時刻、およびタイム・スタンプのデータ・タイプの場合は、文字データ・タイプに変換された場合に値を表示するために必要な SQLCHAR エレメントまたは SQLWCHAR エレメントの数の合計です。

CODEUNITS32 単位で定義された列では、列のコード単位の数が返されます。

数値データ・タイプの場合、COLUMN_SIZE 値は結果セット内の NUM_PREC_RADIX 列の値に基づいて、列に許可されている総桁数または合計ビット数のいずれかです。

データ・タイプ精度の表を参照してください。

列 9  BUFFER_LENGTH (INTEGER)

SQL_C_DEFAULT が SQLBindCol()、SQLGetData() および SQLBindParameter() 呼び出しで指定された場合に、このパラメーターからのデータを保管するための関連する C バッファーの最大バイト。この長さには、NULL 終止符は含まれません。 厳密な数データ・タイプを出すには、長さとして小数部や符号も考慮されます。

SQL ルーチン内の XML 引数の場合、(XML 引数には長さがないため) ゼロが戻されます。 しかし、カタログ式外部ルーチンの場合、XML パラメーターは XML AS CLOB(n) として宣言されます。この場合、BUFFER_LENGTH はカタログされた長さ、n です。

データ・タイプ長の表を参照してください。

列 10  DECIMAL_DIGITS (SMALLINT)

パラメーターのスケール。 スケールが適用できないデータ・タイプの場合は NULL が戻されます。

データ・タイプ・スケールの表を参照してください。

列 11  NUM_PREC_RADIX (SMALLINT)

10、2、または NULL のいずれか。DATA_TYPE が近似値データ・タイプである場合、この列には値 2 が含まれており、COLUMN_SIZE 列にはそのパラメーターに入れられるビット数が含まれています。

DATA_TYPE が高精度数値データ・タイプの場合、この列には値 10 が含まれており、COLUMN_SIZE 列と DECIMAL_DIGITS 列にはそのパラメーターに入れられる小数桁数が含まれています。

数値データ・タイプの場合、DBMS は 10 または 2 の NUM_PREC_RADIX を戻すことができます。

基数が適用できないデータ・タイプの場合は NULL が戻されます。

列 12  NULLABLE (SMALLINT 非 NULL)

パラメーターが NULL を受け入れない場合は SQL_NO_NULLS。

パラメーターが NULL 値を受け入れる場合は SQL_NULLABLE。

列 13  REMARKS (VARCHAR(254))

パラメーターに関する記述情報を入れられます。

列 14  COLUMN_DEF (VARCHAR)

列のデフォルト値。

NULL をデフォルト値として指定した場合、この列は引用符で囲まれていない語 NULL です。切り捨てを行わないとデフォルト値を表すことができない場合、この列には単一引用符で囲まれていない TRUNCATED が入ります。デフォルト値を指定しなかった場合、この列は NULL です。

COLUMN_DEF の値は、TRUNCATED 以外の値であれば新しい列定義を生成するために使用できます。

列 15  SQL_DATA_TYPE (SMALLINT 非 NULL)

SQL_DESC_TYPE 記述子のフィールドに表示される SQL データ・タイプの値。日時データ・タイプは除いて、 この列は DATA_TYPE 列と同じです (CLI はインターバル・データ・タイプをサポートしていません)。

日時データ・タイプの場合、結果セットの SQL_DATA_TYPE フィールドは SQL_DATETIME になり、SQL_DATETIME_SUB フィールドは特定の日時データ・タイプ (SQL_CODE_DATE、SQL_CODE_TIME、または SQL_CODE_TIMESTAMP) のサブコードを戻します。

列 16  SQL_DATETIME_SUB (SMALLINT)

日時データ・タイプのサブタイプ・コード。 他のすべてのデータ・タイプの場合、この列は NULL 値を戻します (CLI がサポートしていないインターバル・データ・タイプを含む)。

列 17  CHAR_OCTET_LENGTH (INTEGER)

文字データ・タイプ列 (CODEUNITS32 として定義されたものも含む) のバイト単位の最大長。 他のすべてのデータ・タイプの場合、この列は NULL を戻します。

列 18  ORDINAL_POSITION (INTEGER NOT NULL)

この結果セットの COLUMN_NAME で指定されているパラメーターの序数部が入れられます。これは、CALL ステートメント上で提供される引数の元の位置です。 左端の引数の元の位置は、1 です。

列 19  IS_NULLABLE (Varchar)

• 列に NULL を含めることができない場合は、「NO」。
• 列に NULL が含まれる場合は、「YES」。
• NULL 可能かどうか不明の場合は、ゼロ長ストリング。

NULL 可能かどうかを判別する際には、ISO 規則に従います。

ISO SQL 準拠の DBMS は、空ストリングを戻すことができません。

この列に戻される値は、NULLABLE 列に戻される値とは異なります。(NULLABLE 列の説明を参照してください。)

• SQL_ERROR
• SQL_INVALID_HANDLE
• SQL_STILL_EXECUTING
• SQL_SUCCESS
• SQL_SUCCESS_WITH_INFO