SQLParamData() - データ値が必要な次のパラメーターを取得する
SQLParamData() は SQLPutData() と一緒に使用して、長いデータを分割して送ります。また、この関数を使用して、固定長データを送ることもできます。
SQLParamData() の ODBC 仕様
| ODBC 仕様レベル | X/Open CLI CAE 仕様 | ISO CLI 仕様 |
|---|---|---|
| 1.0 | あり | あり |
構文
SQLRETURN SQLParamData (SQLHSTMT hstmt,
SQLPOINTER FAR *prgbValue);
関数の引数
次の表は、この関数のそれぞれの引数ごとに、 データ・タイプ、用途、および説明を示しています。
| データ・タイプ | 引数 | 使用法 | 説明 |
|---|---|---|---|
| SQLHSTMT | hstmt | 入力 | ステートメント・ハンドルを指定します。 |
| SQLPOINTER * | prgbValue | 出力 | SQLBindParameter() 呼び出しの引数 rgbValue で示している バッファーを指します。 |
使用法
SQLParamData() は、データが割り当てられていない SQL_DATA_AT_EXEC パラメーター が少なくとも 1 つある場合、SQL_NEED_DATA を戻します。 この関数は、アプリケーションが与えた値 (直前の SQLBindParameter() 呼び出しが用意した値) を prgbValue に戻します。長いデータを分割して送る場合は、SQLPutData() を 1 回以上呼び出します。SQLPutData() 呼び出しの後、SQLParamData() を呼び出して、現行パラメーターのデータが すべて送られたことを知らせ、次の SQL_DATA_AT_EXEC パラメーターに進みます。
すべてのパラメーターにデータ値を割り当てられ、関連したステートメントが正常に実行 されると、SQLParamData() は SQL_SUCCESS を戻します。実際のステートメントの実行時かその前にエラーが発生すると、SQLParamData() は SQL_ERROR を戻します。
- SQLAllocHandle()
- SQLSetConnectAttr()
- SQLNativeSql()
- SQLEndTran()
戻りコード
- SQL_SUCCESS
- SQL_SUCCESS_WITH_INFO
- SQL_ERROR
- SQL_INVALID_HANDLE
- SQL_NEED_DATA
診断
SQLParamData() は、SQLExecDirect() および SQLExecute() が生成する SQLSTATE は、 いずれも戻すことができます。 次の表には、SQLParamData() が生成可能な追加 SQLSTATE とその説明および各値の説明が一覧で記載してあります。
| SQLSTATE | 説明 | 説明 |
|---|---|---|
| 08S01 | 通信リンクに障害が起きました。 | 関数が完了する前に、アプリケーションとデータ・ソース間の 通信リンクで障害が発生しました。 |
| 40001 | トランザクション・ロールバック。 | この SQL ステートメントが属しているトランザクションが、 デッドロックまたはタイムアウトのためにロールバックされました。 |
| HY001 | メモリーの割り振りに失敗しました。 | Db2® ODBC は、関数の実行または完了をサポートするのに必要なメモリーを割り振ることができません。 |
| HY010 | 関数シーケンス・エラーが発生しました。 | 次の 1 つ以上の理由に該当した場合に、この SQLSTATE が戻されます。
|
例
関連例については、関連 SQLGetData() を参照してください。