SQLBrowseConnectSQLBrowseConnect

適用対象: yesSQL Server yesAzure SQL Database yesAzure Synapse Analytics (SQL DW) yesParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database yesAzure Synapse Analytics (SQL DW) yesParallel Data Warehouse

SQLBrowseConnectは、3つのレベルの接続情報に分類できるキーワードを使用します。SQLBrowseConnect uses keywords that can be categorized into three levels of connection information. 次の表では、キーワードごとに、有効な値の一覧が返されるかどうか、およびそのキーワードが省略可能であるかどうかを示します。For each keyword, the following table indicates whether a list of valid values is returned and whether the keyword is optional.

[レベル 1]Level 1

KeywordKeyword 一覧が返されるかどうかList returned? 省略できるかどうかOptional? [説明]Description
DSNDSN なしN/A [いいえ]No Sqldatasourcesソースによって返されるデータソースの名前。Name of the data source returned by SQLDataSources. DSN キーワードは、DRIVER キーワードと同時に使用できません。The DSN keyword cannot be used if the DRIVER keyword is used.
DRIVERDRIVER なしN/A [いいえ]No Microsoft® SQL ServerSQL Server Native Client ODBC ドライバー名は {SQL ServerSQL Server Native Client 11} です。Microsoft® SQL ServerSQL Server Native Client ODBC driver name is {SQL ServerSQL Server Native Client 11}. DRIVER キーワードは、DSN キーワードと同時に使用できません。The DRIVER keyword cannot be used if the DSN keyword is used.

[レベル 2]Level 2

KeywordKeyword 一覧が返されるかどうかList returned? 省略できるかどうかOptional? [説明]Description
SERVERSERVER はいYes [いいえ]No データ ソースがあるネットワーク上のサーバー名。Name of the server on the network on which the data source resides. サーバー名には「(local)」と入力することもできます。これは、ネットワークに接続されていない SQL ServerSQL Server のローカル コピーも使用できることを意味します。The term "(local)" can be entered as the server, in which case a local copy of SQL ServerSQL Server can be used, even when this is a non-networked version.
UIDUID [いいえ]No はいYes ユーザー ログイン ID。User login ID.
PWDPWD [いいえ]No はい (ユーザーによって異なります)Yes (depends on the user) ユーザーが指定したパスワード。User-specified password.
APPAPP [いいえ]No はいYes SQLBrowseConnectを呼び出すアプリケーションの名前。Name of the application calling SQLBrowseConnect.
WSIDWSID [いいえ]No はいYes ワークステーション ID。Workstation ID. 通常は、アプリケーションが実行されているコンピューターのネットワーク名です。Typically, this is the network name of the computer on which the application runs.

[レベル 3]Level 3

KeywordKeyword 一覧が返されるかどうかList returned? 省略できるかどうかOptional? [説明]Description
DATABASEDATABASE はいYes はいYes SQL ServerSQL Server データベースの名前。Name of the SQL ServerSQL Server database.
LANGUAGELANGUAGE はいYes はいYes SQL ServerSQL Server で使用される言語。National language used by SQL ServerSQL Server.

SQLBrowseConnectは、ODBC データソースの定義に格納されているデータベースと言語キーワードの値を無視します。SQLBrowseConnect ignores the values of the DATABASE and LANGUAGE keywords stored in the ODBC data source definitions. SQLBrowseConnectに渡された接続文字列で指定されたデータベースまたは言語が無効である場合、 SQLBrowseConnectは SQL_NEED_DATA とレベル3の接続属性を返します。If the database or language specified in the connection string passed to SQLBrowseConnect is invalid, SQLBrowseConnect returns SQL_NEED_DATA and the level 3 connection attributes.

SQLSetConnectAttrを呼び出すことによって設定される次の属性は、 SQLBrowseConnectによって返される結果セットを決定します。The following attributes, which are set by calling SQLSetConnectAttr, determine the result set returned by SQLBrowseConnect.

[属性]Attribute [説明]Description
SQL_COPT_SS_BROWSE_CONNECTSQL_COPT_SS_BROWSE_CONNECT SQL_MORE_INFO_YES に設定されている場合、 SQLBrowseConnectはサーバープロパティの拡張文字列を返します。If it is set to SQL_MORE_INFO_YES, SQLBrowseConnect returns an extended string of server properties.

SQLBrowseConnectによって返される拡張文字列の例を次に示します。The following is an example of an extended string returned by SQLBrowseConnect:



ServerName\InstanceName;Clustered:No;Version:8.00.131



この文字列では、サーバーに関するさまざまな情報がセミコロンで区切られます。In this string, semi-colons separate various pieces of information about the server. コンマは、異なるサーバー インスタンスを区切るために使用します。Use commas to separate different server instances.
SQL_COPT_SS_BROWSE_SERVERSQL_COPT_SS_BROWSE_SERVER サーバー名が指定されている場合、 SQLBrowseConnectは指定されたサーバーの情報を返します。If a server name is specified, SQLBrowseConnect will return information for the server specified. SQL_COPT_SS_BROWSE_SERVER が NULL に設定されている場合、 SQLBrowseConnectはドメイン内のすべてのサーバーに関する情報を返します。If SQL_COPT_SS_BROWSE_SERVER is set to NULL, SQLBrowseConnect returns information for all servers in the domain.



ネットワークの問題のため、 SQLBrowseConnectは、すべてのサーバーからタイムリーな応答を受信できない可能性があります。Note that due to network issues, SQLBrowseConnect might not receive a timely response from all servers. したがって、要求ごとに返されるサーバーの一覧が異なる可能性があります。Therefore, the list of servers returned can vary for each request.
SQL_COPT_SS_BROWSE_CACHE_DATASQL_COPT_SS_BROWSE_CACHE_DATA SQL_COPT_SS_BROWSE_CACHE_DATA 属性が SQL_CACHE_DATA_YES に設定されている場合は、バッファー長の不足が原因で結果を保持できないときにデータをチャンクでフェッチできます。When the SQL_COPT_SS_BROWSE_CACHE_DATA attribute is set to SQL_CACHE_DATA_YES, you can fetch data in chunks when the buffer length is not large enough to hold the result. この長さは、SQLBrowseConnect の BufferLength 引数で指定されます。This length is specified in the BufferLength argument to SQLBrowseConnect.

バッファー長を超えるデータがあるときは SQL_NEED_DATA が返されます。SQL_NEED_DATA is returned when more data is available. 取得対象のデータがそれ以上ないときは SQL_SUCCESS が返されます。SQL_SUCCESS is returned when there is no more data to retrieve.

既定値は SQL_CACHE_DATA_NO です。The default is SQL_CACHE_DATA_NO.

SQLBrowseConnect の HADR サポートSQLBrowseConnect Support for High Availability, Disaster Recovery

SQLBrowseConnectを使用して Always On 可用性グループAlways On availability groups クラスターに接続する方法の詳細については、「高可用性、ディザスターリカバリーのサポートの SQL Server Native Client」を参照してください。For more information on using SQLBrowseConnect to connect to an Always On 可用性グループAlways On availability groups cluster, see SQL Server Native Client Support for High Availability, Disaster Recovery.

SQLBrowseConnect によるサービス プリンシパル名 (SPN) のサポートSQLBrowseConnect Support for Service Principal Names (SPNs)

接続が開いている場合、SQL ServerSQL Server Native Client では、SQL_COPT_SS_MUTUALLY_AUTHENTICATED および SQL_COPT_SS_INTEGRATED_AUTHENTICATION_METHOD が、接続を開くときに使用された認証方式に設定されます。When a connection is opened, SQL ServerSQL Server Native Client sets SQL_COPT_SS_MUTUALLY_AUTHENTICATED and SQL_COPT_SS_INTEGRATED_AUTHENTICATION_METHOD to the authentication method used to open the connection.

Spn の詳細については、「クライアント(接続) (ODBC)でのサービスプリンシパル名 spn」を参照してください。For more information about SPNs, see Service Principal Names (SPNs) in Client Connections (ODBC).

変更履歴Change History

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

参照See Also

SQLBrowseConnect 関数 SQLBrowseConnect Function
ODBC API 実装の詳細ODBC API Implementation Details