SQLParamData 関数

準拠
導入されたバージョン: ODBC 1.0 標準コンプライアンス: ISO 92

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

構文

  
SQLRETURN SQLParamData(  
     SQLHSTMT       StatementHandle,  
     SQLPOINTER *   ValuePtrPtr);  

引数

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

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

返品

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

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

Comments

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

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

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

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

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

アプリケーションは、 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 の使用」、 sqlBulkOperations の「ブックマークを使用した一括更新の実行」、「 SQLBulkOperations」、および「 Long Data and SQLSetPos および SQLBulkOperations」の「SQLSetPos の使用」セクションを参照してください。

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

コード例

SQLPutData を参照してください。

関連する関数

関連するコンテンツ

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