SQLBrowseConnect

適用対象: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

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

レベル 1

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

レベル 2

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

レベル 3

Keyword 一覧が返されるかどうか 省略できるかどうか 説明
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 です。

SQLBrowseConnect の HADR サポート

SQLBrowseConnect を使用して Always On 可用性グループ クラスターに接続する方法の詳細については、「SQL Server Native Client Support for high availability, disaster Recovery」を参照してください。

SQLBrowseConnect によるサービス プリンシパル名 (SPN) のサポート

接続が開かれると、SQL Server Native Client はSQL_COPT_SS_MUTUALLY_AUTHENTICATEDを設定し、接続を開くために使用される認証方法にSQL_COPT_SS_INTEGRATED_AUTHENTICATION_METHODします。

SPN の詳細については、「クライアント接続 (ODBC)の「Service Principal Names (SPN)」を参照してください。

変更履歴

変更内容
SQL_COPT_SS_BROWSE_CACHE_DATA に関する記述を追加しました。

参照

SQLBrowseConnect 関数
ODBC API 実装の詳細