SQLNumParams - SQL ステートメントのパラメーターの数を取得

目的

仕様: DB2 CLI 2.1 ODBC 1.0

SQLNumParams() は SQL ステートメント内のパラメーター・マーカーの数を戻します。

構文

SQLRETURN   SQLNumParams     (SQLHSTMT          StatementHandle,
                              SQLSMALLINT  FAR  *ParameterCountPtr);

関数の引き数

表 94. SQLNumParams の引き数

データ・タイプ 引き数 用途 説明
SQLHSTMT StatementHandle 入力 ステートメント・ハンドル。
SQLSMALLINT ParameterCountPtr 出力 ステートメント内のパラメーターの数。

使用法

StatementHandle と関連したステートメントが準備された後にのみ、この関数を呼び出すことができます。ステートメントにパラメーター・マーカーが含まれていない場合、 ParameterCountPtr はゼロに設定されます。

アプリケーションではこの関数を呼び出して、ステートメント・ハンドルと関連した SQL ステートメントに対して必要な、SQLBindParameter() 呼び出しの回数を判別することができます。

戻りコード

診断

表 95. SQLNumParams の SQLSTATE

SQLSTATE 説明 解説
HY001 メモリーの割り振りの失敗。 DB2 CLI が、関数を実行または完了させるのに必要なメモリーを割り当てることができない。
HY010 関数のシーケンス・エラー。 指定された StatementHandle に対して SQLPrepare() が呼び出される前に、この関数が呼び出された。
HY013 予期しないメモリー処理エラー。 DB2 CLI が、関数を実行または完了させるのに必要なメモリーにアクセスできなかった。

制約事項

なし。

関連した解説