SQLBrowseConnect

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

SQLBrowseConnect では、3 つのレベルに分類できる接続情報のキーワードを使用します。次の表では、キーワードごとに、有効な値の一覧が返されるかどうか、およびそのキーワードが省略可能であるかどうかを示します。

レベル 1

キーワード	一覧が返されるかどうか	省略できるかどうか	説明
DSN	N/A	いいえ	SQLDataSources で返されるデータソースの名前。 DSN キーワードは、DRIVER キーワードと同時に使用できません。
DRIVER	N/A	いいえ	Microsoft® SQL Server Native Client ODBC ドライバーの名前は {SQL Server Native Client 11} です。 DRIVER キーワードは、DSN キーワードと同時に使用できません。

レベル 2

キーワード	一覧が返されるかどうか	省略できるかどうか	説明
SERVER	はい	いいえ	データソースがあるネットワーク上のサーバー名。サーバー名には「(local)」と入力することもできます。これは、ネットワークに接続されていない SQL Server のローカルコピーも使用できることを意味します。
UID	いいえ	はい	ユーザーログイン ID。
PWD	いいえ	はい (ユーザーによって異なります)	ユーザーが指定したパスワード。
APP	いいえ	はい	SQLBrowseConnect を呼び出すアプリケーションの名前。
WSID	いいえ	はい	ワークステーション ID。通常は、アプリケーションが実行されているコンピューターのネットワーク名です。

レベル 3

キーワード	一覧が返されるかどうか	省略できるかどうか	説明
DATABASE	はい	はい	SQL Server データベースの名前。
LANGUAGE	はい	はい	SQL Server で使用される言語。

SQLBrowseConnect では、ODBC データソース定義に格納されている DATABASE キーワードと LANGUAGE キーワードの値が無視されます。 SQLBrowseConnect に渡す接続文字列に無効なデータベースや言語を指定した場合は、SQLBrowseConnect によって、SQL_NEED_DATA とレベル 3 の接続属性が返されます。

SQLSetConnectAttr を呼び出して設定する次の属性によって、SQLBrowseConnect から返される結果セットが決まります。

属性

説明

SQL_COPT_SS_BROWSE_CONNECT

この属性を SQL_MORE_INFO_YES に設定すると、SQLBrowseConnect によってサーバープロパティの拡張文字列が返されます。

SQLBrowseConnect により返される拡張文字列の例を次に示します。

ServerName\InstanceName;Clustered:No;Version:8.00.131

この文字列では、サーバーに関するさまざまな情報がセミコロンで区切られます。コンマは、異なるサーバーインスタンスを区切るために使用します。

SQL_COPT_SS_BROWSE_SERVER

サーバー名を指定すると、SQLBrowseConnect によって、指定したサーバーに関する情報が返されます。 SQL_COPT_SS_BROWSE_SERVER に NULL を設定すると、SQLBrowseConnect によって、ドメイン内のすべてのサーバーに関する情報が返されます。

注
ネットワークの問題により、SQLBrowseConnect は、すべてのサーバーからタイムリーな応答を受信できない場合があります。したがって、要求ごとに返されるサーバーの一覧が異なる可能性があります。

SQL_COPT_SS_BROWSE_CACHE_DATA

SQL_COPT_SS_BROWSE_CACHE_DATA 属性が SQL_CACHE_DATA_YES に設定されている場合は、バッファー長の不足が原因で結果を保持できないときにデータをチャンクでフェッチできます。この長さは、SQLBrowseConnect に対する引数 BufferLength で指定されます。

バッファー長を超えるデータがあるときは SQL_NEED_DATA が返されます。取得対象のデータがそれ以上ないときは SQL_SUCCESS が返されます。

既定値は SQL_CACHE_DATA_NO です。