SQLGetConnectAttr

[アーティクル]
05/07/2013

SQL Server Native Client ODBC ドライバーでは、ドライバー固有の接続属性が定義されます。 SQLGetConnectAttr 関数では、このような属性のいくつかを使用できるので、この関数を使用してこれらの属性に関する現在の設定を報告できます。接続が成功するまで、または SQLSetConnectAttr を使用して属性が設定されるまで、これらの属性について報告される値は保証されません。

ここでは、読み取り専用の属性を示します。その他の SQL Server Native Client ODBC ドライバー固有の接続属性の詳細については、「SQLSetConnectAttr」を参照してください。

SQL_COPT_SS_CONNECTION_DEAD

SQL_COPT_SS_CONNECTION_DEAD 属性では、サーバーへの接続状態が報告されます。ドライバーは、接続の現在の状態をネットワークにクエリします。

注
標準の ODBC 接続属性 SQL_ATTR_CONNECTION_DEAD は、接続の最新の状態を返します。これは現在の接続状態と異なる場合があります。

値	説明
SQL_CD_TRUE	サーバーへの接続が失われました。
SQL_CD_FALSE	接続が開かれており、ステートメントの処理に使用できます。

SQL_COPT_SS_CLIENT_CONNECTION_ID

SQL_COPT_SS_CLIENT_CONNECTION_ID 属性は、クライアント接続 ID を取得します。この ID を使用すると、次の情報を検索できます。

XEvent ログの診断情報 (有効な場合)。
接続リングバッファーの接続エラー情報。
データアクセスのトレースログの診断情報 (有効な場合)。

詳細については、「拡張イベントログの診断情報へのアクセス」を参照してください。

値	説明
SQL_ERROR	接続に失敗しました。
SQL_SUCCESS	接続に成功しました。クライアント接続 ID は出力バッファーで見つかります。

SQL_COPT_SS_PERF_DATA

SQL_COPT_SS_PERF_DATA 属性は、現在のドライバーのパフォーマンス統計情報を保持する SQLPERF 構造体へのポインターを返します。 SQLGetConnectAttr では、パフォーマンスのログ記録が無効の場合は NULL を返します。 SQLPERF 構造体内の統計情報がドライバーで動的に更新されることはありません。パフォーマンス統計情報の更新が必要になるたびに SQLGetConnectAttr を呼び出してください。

値	説明
NULL	パフォーマンスのログ記録が無効です。
その他の値	SQLPERF 構造体へのポインター。

SQL_COPT_SS_PERF_QUERY

SQL_COPT_SS_PERF_QUERY 属性は、実行時間の長いクエリのログ記録が有効の場合に TRUE を返します。クエリのログ記録が無効の場合は FALSE を返します。

SQL_COPT_SS_USER_DATA

SQL_COPT_SS_USER_DATA 属性は、ユーザーデータポインターを取得します。ユーザーデータはクライアントのメモリに格納され、接続ごとに記録されます。ユーザーデータポインターが設定されていない場合、SQL_UD_NOTSET という NULL ポインターが返されます。

値	説明
SQL_UD_NOTSET	ユーザーデータポインターが設定されていません。
その他の値	ユーザーデータへのポインターです。