SQLSetDriverConnectInfo 関数
準拠
導入されたバージョン: ODBC 3.81 Standards Compliance: ODBC
まとめ
SQLSetDriverConnectInfo は、アプリケーションの SQLDriverConnect 呼び出しの接続文字列トークンに接続文字列を設定するために使用されます。
構文
SQLRETURN SQLSetDriverConnectInfo(
SQLHDBC_INFO_TOKEN hDbcInfoToken,
WCHAR * InConnectionString,
SQLSMALLINT StringLength1 );
引数
TokenHandle
[入力]トークン ハンドル。
InConnectionString
[入力]完全な接続文字列 ( SQLDriverConnect の "Comments" の構文を参照)、部分的な接続文字列、または空の文字列。
StringLength1
[入力]文字列が Unicode の場合は *InConnectionString、文字列が ANSI または DBCS の場合はバイト単位の長さ。
戻り値
SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。
診断
入力検証エラーに関連する SQLDriverConnect と同じですが、ドライバー マネージャーでは、SQL_HANDLE_DBC_INFO_TOKEN の HandleType と hDbcInfoToken の Handle が使用されます。
解説
ドライバーがSQL_ERRORまたはSQL_INVALID_HANDLEを返すたびに、ドライバー マネージャーはアプリケーション ( SQLConnect または SQLDriverConnect) にエラーを返します。
ドライバーがSQL_SUCCESS_WITH_INFOを返すたびに、ドライバー マネージャーは hDbcInfoToken から診断情報を取得し、SQLConnect と SQLDriverConnect でアプリケーションにSQL_SUCCESS_WITH_INFOを返します。
アプリケーションでは、この関数を直接呼び出さないでください。 ドライバー対応の接続プールをサポートする ODBC ドライバーは、この関数を実装する必要があります。
ODBC ドライバー開発に sqlspi.h を含めます。