SQLSetConnectInfo 関数

  • [アーティクル]

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

まとめ
SQLSetConnectInfo は、データ ソース、ユーザー ID、およびパスワードを、アプリケーションの SQLConnect 呼び出しの接続情報トークンに設定するために使用されます。

構文

  
SQLRETURN  SQLSetConnectInfo(  
                SQLHDBC_INFO_TOKEN   TokenHandle,  
                WCHAR *              ServerName,  
                SQLSMALLINT          NameLength1,  
                WCHAR *              UserName,  
                SQLSMALLINT          NameLength2,  
                WCHAR *              Authentication,  
                SQLSMALLINT          NameLength3 );

引数

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

ServerName
[入力]データ ソース名。 データは、プログラムと同じコンピューター、またはネットワーク上の別のコンピューターに配置されている可能性があります。 アプリケーションでデータ ソースを選択する方法の詳細については、「 データ ソースまたはドライバーの選択」を参照してください。

NameLength1
[入力]文字単位の *ServerName の長さ。

UserName
[入力]ユーザー識別子。

NameLength2
[入力]文字単位の *UserName の長さ。

認証
[入力]認証文字列 (通常はパスワード)。

NameLength3
[入力]文字単位の *認証 の長さ。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

診断

入力検証エラーの SQLConnect と同じですが、ドライバー マネージャーで handleType のSQL_HANDLE_DBC_INFO_TOKENと hDbcInfoToken のハンドルが使用される点が除きます。

解説

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

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

アプリケーションでは、この関数を直接呼び出さないでください。 ドライバー対応接続プールをサポートする ODBC ドライバーは、この関数を実装する必要があります。

ODBC ドライバー開発用に sqlspi.h を含めます。

参照

ODBC ドライバーの開発
ドライバー対応接続プール
ODBC ドライバー対応接続プールの開発