SQLSetDriverConnectInfo 関数

適合 性
導入されたバージョン:ODBC 3.81 規格準拠:ODBC

Summary
SQLSetDriverConnectInfoは、アプリケーションのSQLDriverConnect呼び出しの接続情報トークンに接続文字列を設定するために使用されます。

構文

  
SQLRETURN SQLSetDriverConnectInfo(  
                SQLHDBC_INFO_TOKEN   hDbcInfoToken,  
                WCHAR *              InConnectionString,  
                SQLSMALLINT          StringLength1 );  

引数

トークンハンドル
[入力]トークンハンドル。

InConnectionString
[入力]完全な接続文字列(SQLDriverConnectの「Comments」の構文を参照)、部分的な接続文字列、または空の文字列。

StringLength1
[入力]*InConnectionStringの長さは、文字列がUnicodeの場合は文字数、ANSIまたはDBCSの場合はバイト数です。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

Diagnostics

入力検証エラーに関してはSQLDriverConnectと同様に、ドライバーマネージャーはHandleType(SQL_HANDLE_DBC_INFO_TOKEN)とhDbcInfoTokenHandleを使用します。

Remarks

ドライバーがSQL_ERRORまたはSQL_INVALID_HANDLEを返すたびに、ドライバーマネージャーはエラーをアプリケーション( SQLConnect または SQLDriverConnect)に返します。

ドライバーがSQL_SUCCESS_WITH_INFOを返すたびに、ドライバーマネージャーは hDbcInfoTokenから診断情報を取得し、 SQLConnect および SQLDriverConnectでSQL_SUCCESS_WITH_INFOをアプリケーションに返します。

アプリケーションはこの関数を直接呼び出すべきではありません。 ドライバー認識接続プーリングをサポートするODBCドライバーはこの機能を実装しなければなりません。

ODBCドライバー開発のためにsqlspi.hを含めてください。