SQLParamData 関数

準拠
導入されたバージョン: ODBC 1.0 Standards Compliance: ISO 92

まとめ
SQLParamData は SQLPutData と共に使用され、ステートメントの実行時にパラメーター データを提供し、 SQLGetData を使用してストリーム出力パラメーター データを取得します。

構文

  
SQLRETURN SQLParamData(  
     SQLHSTMT       StatementHandle,  
     SQLPOINTER *   ValuePtrPtr);  

引数

StatementHandle
[入力]ステートメント ハンドル。

ValuePtrPtr
[出力]SQLBindParameter で指定された ParameterValuePtr バッファーのアドレス (パラメーター データの場合) または SQLBindCol で指定された TargetValuePtr バッファーのアドレス (列データの場合) を返すバッファーへのポインター。これは、SQL_DESC_DATA_PTR記述子レコード フィールドに含まれています。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NEED_DATA、SQL_NO_DATA、SQL_STILL_EXECUTING、SQL_ERROR、SQL_INVALID_HANDLE、またはSQL_PARAM_DATA_AVAILABLE。

診断

SQLParamData がSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、関連付けられた SQLSTATE 値を取得するには、SQL_HANDLE_STMTの HandleType と StatementHandle の Handle を指定して SQLGetDiagRec を呼び出します。 次の表に、 SQLParamData によって通常返される SQLSTATE 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。表記 "(DM)" は、ドライバー マネージャーによって返される SQLSTATEs の説明の前にあります。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERRORされます。

SQL ステートメントのパラメーターのデータの送信中に SQLParamData が呼び出された場合、ステートメントを実行するために呼び出された関数によって返される任意の SQLSTATE (SQLExecute または SQLExecDirect) を返すことができます。 SQLBulkOperations で更新または追加される列のデータの送信中または SQLSetPos による更新中に呼び出された場合は、SQLBulkOperations または SQLSetPos によって返される任意の SQLSTATE を返すことができます。

説明

SQLParamData を呼び出して、 SQLExecute または SQLExecDirect の呼び出しで使用されるパラメーター データ、または SQLBulkOperations の呼び出しまたは SQLSetPos の呼び出しによって行が更新または追加されたときに使用される列データの 2 つの用途で、実行時データを提供できます。 実行時に、 SQLParamData は、ドライバーが必要とするデータを示すインジケーターをアプリケーションに返します。

アプリケーションが SQLExecute、SQLExecDirect、SQLBulkOperations、または SQLSetPos を呼び出すと、実行時データが必要な場合、ドライバーはSQL_NEED_DATAを返します。 その後、アプリケーションは SQLParamData を呼び出して、送信するデータを決定します。 ドライバーでパラメーター データが必要な場合、ドライバーは、アプリケーションが行セット バッファーに格納した値を *ValuePtrPtr 出力バッファーで返します。 アプリケーションでは、この値を使用して、ドライバーが要求しているパラメーター データを決定できます。 ドライバーで列データが必要な場合、ドライバーは *ValuePtrPtr バッファーで、列が最初にバインドされたアドレスを次のように返します。

バインドされたアドレス + バインディング オフセット + ((行番号 - 1) x 要素サイズ)

ここで、変数は次の表に示すように定義されています。

また、データを送信するために SQLPutData を呼び出す必要があることをアプリケーションに示すSQL_NEED_DATAも返します。

アプリケーションは、 SQLPutData を必要な回数だけ呼び出して、列またはパラメーターの実行時データを送信します。 列またはパラメーターのすべてのデータが送信されると、アプリケーションは SQLParamData を再度呼び出します。 SQLParamData が再びSQL_NEED_DATAを返す場合は、別のパラメーターまたは列に対してデータを送信する必要があります。 したがって、アプリケーションは再び SQLPutData を呼び出します。 すべてのパラメーターまたは列に対してすべての実行時データが送信された場合、 SQLParamData はSQL_SUCCESSまたはSQL_SUCCESS_WITH_INFOを返します。 *ValuePtrPtr の値は未定義であり、SQL ステートメントを実行することも、 SQLBulkOperations または SQLSetPos 呼び出しを処理することもできます。

SQLParamData が、データ ソースの行に影響を与えない検索された更新または削除ステートメントのパラメーター データを提供する場合、SQLParamData の呼び出しはSQL_NO_DATAを返します。

ステートメントの実行時に実行データのパラメーター データを渡す方法の詳細については、「 SQLBindParameter のパラメーター値の受け渡し」と「 長いデータの送信」を参照してください。 実行時のデータ列データの更新または追加方法の詳細については、SQLSetPos の「SQLSetPos の使用」、SQLBulkOperations の「ブックマークを使用した一括更新の実行」、および「Long Data and SQLSetPos and SQLBulkOperations」のセクションを参照してください。

SQLParamData を呼び出して、ストリーム出力パラメーターを取得できます。 SQLMoreResults、SQLExecute、SQLGetData、または SQLExecDirect がSQL_PARAM_DATA_AVAILABLEを返す場合は、SQLParamData を呼び出して、使用可能な値を持つパラメーターを確認します。 SQL_PARAM_DATA_AVAILABLEおよびストリーム出力パラメーターの詳細については、「 SQLGetData を使用した出力パラメーターの取得」を参照してください。

コード例

「SQLPutData」を参照してください。

関連する関数

参照

ODBC API リファレンス
ODBC ヘッダー ファイル
SQLGetData を使用した出力パラメーターの取得