適合 性
導入されたバージョン:ODBC 3.8 規格準拠:ODBC
Summary
SQLPoolConnect は、プール内の再利用できない接続がない場合に新しい接続を作成するために使用されます。
構文
SQLRETURN SQLPoolConnect(
SQLHDBC hDbc,
SQLHDBC_INFO_TOKEN hDbcInfoToken,
WCHAR * wszOutConnectString,
SQLSMALLINT cchConnectStringBuffer,
SQLSMALLINT * cchConnectStringLen );
引数
hDbc
[入力]接続ハンドルです。
hDbcInfoToken
[入力]新しいアプリケーション接続要求のためのトークンハンドル。
wszOutConnectString
[出力]完了した接続文字列のバッファへのポインタ。 ターゲットデータソースへの接続が成功すると、このバッファには完了した接続文字列が収まります。 アプリケーションはこのバッファに少なくとも1,024文字を割り当てるべきです。
wszOutConnectStringがNULLの場合、cchConnectStringLenはwszOutConnectStringが指すバッファ内で返せる文字数(文字データのnull終端文字を除く)を返します。
cchConnectStringBuffer
[入力]*wszOutConnectString バッファの長さ(文字数)。
cchConnectStringLen
[出力]*wszOutConnectStringで返せる文字数(null終端文字を除く)を返すバッファへのポインタです。 返せる文字数がcchConnectStringBuffer以上であれば、*wszOutConnectStringの完了した接続文字列はcchConnectStringBufferの長さからnull終端文字の長さを引いたものに切り詰められます。
返品
SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。
Diagnostics
SQLDriverConnectと同様に、入力検証エラーに対しても対応しますが、ドライバーマネージャーはHandleType(SQL_HANDLE_DBC_INFO_TOKEN)とhDbcInfoTokenのHandleを使用します。
Remarks
ドライバーマネージャーは 、hDbc と hDbcInfoToken の親HENVハンドルが同一であることを保証します。
SQLDriverConnectとは異なり、DriverCompletionの引数はユーザーに接続情報の入力を促すものではありません。 プーリングシナリオではプロンプト付きダイアログは許可されません。
アプリケーションはこの関数を直接呼び出すべきではありません。 ドライバー認識接続プーリングをサポートするODBCドライバーはこの機能を実装しなければなりません。
ドライバーがSQL_ERRORまたはSQL_INVALID_HANDLEを返すたびに、ドライバーマネージャーはエラーをアプリケーション( SQLConnect または SQLDriverConnect)に返します。
ドライバーがSQL_SUCCESS_WITH_INFOを返すたびに、ドライバーマネージャーは hDbcInfoTokenから診断情報を取得し、 SQLConnect および SQLDriverConnectでSQL_SUCCESS_WITH_INFOをアプリケーションに返します。
アプリケーションが SQLConnectを使用すると、 wszOutConnectString はNULLバッファとなります(最後の3つのパラメータはすべてNULL, 0, NULLに設定されます)。 そうでなければ、ドライバーは出力接続文字列を返す必要があり、それはアプリケーションのSQLDriverConnect Function呼び出しに返されます。
ODBCドライバー開発のためにsqlspi.hを含めてください。