SQLDescribeParam() - パラメーター・マーカーを記述する

SQLDescribeParam() は、準備済みステートメントに関連したパラメーター・マーカーの記述を取り出します。この関数は、Db2® for z/OS® のデータ・ソースに対してのみサポートされます。この関数を呼び出す前に、SQLPrepare() または SQLExecDirect() のいずれかを呼び出す必要があります。

SQLDescribeParam() の ODBC 仕様

表 1. SQLDescribeParam() の仕様
ODBC 仕様レベル X/Open CLI CAE 仕様 ISO CLI 仕様
1.0 あり あり

構文

31 ビット・アプリケーションの場合、次の構文を使用します。

SQLRETURN  SQLDescribeParam  (SQLHSTMT          hstmt,
                              SQLUSMALLINT      ipar,
                              SQLSMALLINT FAR     *pfSqlType,
                              SQLUINTEGER FAR     *pcbColDef,
                              SQLSMALLINT FAR     *pibScale,
                              SQLSMALLINT FAR     *pfNullable);

64 ビット・アプリケーションの場合、次の構文を使用します。

SQLRETURN  SQLDescribeParam  (SQLHSTMT          hstmt,
                              SQLUSMALLINT      ipar,
                              SQLSMALLINT FAR     *pfSqlType,
                              SQLULEN     FAR     *pcbColDef,
                              SQLSMALLINT FAR     *pibScale,
                              SQLSMALLINT FAR     *pfNullable);

関数の引数

次の表は、この関数のそれぞれの引数ごとに、 データ・タイプ、用途、および説明を示しています。

表 2. SQLDescribeParam() の引数
データ・タイプ 引数 使用法 説明
SQLHSTMT hstmt 入力 ステートメント・ハンドルを指定します。
SQLUSMALLINT ipar 入力 パラメーター・マーカーの番号を指定します。(パラメーター・マーカーは、 準備済み SQL ステートメントの中で、左から右へ、1 から順番に番号が付けられています。)
SQLSMALLINT * pfSqlType 出力 基本 SQL データ・タイプを指定します。
SQLUINTEGER * (31 ビット) または SQLULEN * (64 ビット) 1 pcbColDef 出力 パラメーター・マーカーの精度を戻します。
SQLSMALLINT * pibScale 出力 パラメーター・マーカーの位取りを戻します。
SQLSMALLINT * pfNullable 出力 パラメーターで NULL 値が許されているかどうかを示します。 この引数は、次のいずれかの値を戻します。
  • SQL_NO_NULLS: パラメーターでは NULL 値は許されていません。これがデフォルトです。
  • SQL_NULLABLE: パラメーターでは NULL 値が許されています。
  • SQL_NULLABLE_UNKNOWN: ドライバーは、パラメーターで NULL 値が許されているか どうかを判別できません。
注:
  1. 64 ビット・アプリケーションの場合、旧バージョンの Db2 で使用されていたデータ・タイプ SQLUINTEGER は、引き続き有効です。ただし、アプリケーションのポータビリティーを最大限に引き出すために、SQLULEN の使用をお勧めします。

使用法

特殊タイプの場合、SQLDescribeParam() は、入力パラメーターについては 両方の基本データ・タイプを戻します。

SQLDescribeParam() は、SQL ステートメント内のパラメーターの用途が入力、入出力、または出力のどれであるかを示す標識を戻しません。ストアード・プロシージャーの呼び出しの場合を除き、SQL ステートメントのパラメーターはすべて入力パラメーターです。ストアード・プロシージャーの呼び出しに使用される各パラメーターのタイプを判別するには、SQLProcedureColumns() を呼び出します。

戻りコード

SQLDescribeParam() は、呼び出された後、次のいずれかの値を戻します。
  • SQL_SUCCESS
  • SQL_SUCCESS_WITH_INFO
  • SQL_ERROR
  • SQL_INVALID_HANDLE
  • SQL_NO_DATA_FOUND

診断

次の表は、この関数が生成する各 SQLSTATE 値ごとに、 その記述と説明を一覧で記載してあります。

表 3. SQLDescribeParam() の SQLSTATE
SQLSTATE 説明 説明
01000 警告。 これは通知メッセージであり、指定された接続属性を設定する処理の一部として、 アプリケーションに代わって内部コミットが出されたことを示す。
HY000 一般エラー。 具体的な SQLSTATE が定義されないエラーが起こり ました。SQLGetDiagRec() によって引数 MessageText に戻されたエラー・メッセージに、エラーとその原因が記述されています。
HY001 メモリーの割り振りに失敗しました。 Db2 ODBC は、関数の実行または完了をサポートするのに必要なメモリーを割り振ることができません。
HY010 関数シーケンス・エラーが発生しました。 この関数は、実行時データの操作時に呼び出されました。(すなわち、SQLParamData() または SQLPutData() 関数を使用するプロシージャー実行中に関数が呼び出されました。)
HY093 パラメーター番号が無効です。 引数 ipar に指定された値が 1 より小さいか、 または関連する SQL ステートメントで必要なパラメーター数よりも大きな値です。
HYC00 ドライバーは使用できません。 データ・ソースは、Db2 for z/OS または Db2 for Linux, UNIX, and Windows ではありません。