SQLDataSources 関数

適合 性
導入されたバージョン: ODBC 1.0 標準コンプライアンス: ISO 92

Summary
SQLDataSources はデータソースに関する情報を返します。 この機能はドライバーマネージャーのみによって実装されます。

構文

  
SQLRETURN SQLDataSources(  
     SQLHENV          EnvironmentHandle,  
     SQLUSMALLINT     Direction,  
     SQLCHAR *        ServerName,  
     SQLSMALLINT      BufferLength1,  
     SQLSMALLINT *    NameLength1Ptr,  
     SQLCHAR *        Description,  
     SQLSMALLINT      BufferLength2,  
     SQLSMALLINT *    NameLength2Ptr);  

引数

EnvironmentHandle
[入力]環境の取り扱い。

方向
[入力]ドライバーマネージャーがどのデータソースについて情報を返すかを決定します。 次のことができます。

SQL_FETCH_NEXT(リスト内の次のデータソース名を取得する)、SQL_FETCH_FIRST(リストの冒頭から取得)、SQL_FETCH_FIRST_USER(最初のユーザーDSNを取得する)、SQL_FETCH_FIRST_SYSTEM(最初のシステムDSNを取得する)。

DirectionがSQL_FETCH_FIRSTに設定されている場合、DirectionをSQL_FETCH_NEXTに設定したSQLDataSourcesへのその後の呼び出しはユーザーおよびシステムDSNの両方を返します。 DirectionがSQL_FETCH_FIRST_USERに設定されている場合、DirectionをSQL_FETCH_NEXTに設定したSQLDataSourcesへのすべての呼び出しはユーザーのDSNのみを返します。 DirectionがSQL_FETCH_FIRST_SYSTEMに設定されている場合、DirectionをSQL_FETCH_NEXTに設定したSQLDataSourcesへのその後のすべての呼び出しはシステムのDSNのみを返します。

ServerName
[出力]データソース名を返すためのバッファへのポインタ。

ServerNameがNULLの場合、NameLength1Ptr はServerNameが指すバッファ内で返せる文字数(文字データのnull終端文字を除く)を返します。

バッファ長1
[入力]*ServerName バッファの長さ(文字数);これはnull-terminationキャラクターを加えた長さSQL_MAX_DSN_LENGTHより長くなくても十分です。

名前長1Ptr
[出力]*ServerNameで返せる文字数(null終端文字を除く)を返すためのバッファへのポインタ。 返す文字数が BufferLength1以上の場合、*ServerName のデータソース名は BufferLength1 からnull終端文字の長さを引いたものに短縮されます。

Description
[出力]データソースに関連付けられたドライバーの記述を返すためのバッファへのポインタ。 例えば、dBASEやSQL Serverなどです。

DescriptionがNULLの場合、NameLength2Ptr は記述が指すバッファ内で返せる文字数(文字データのnull終端文字を除く)を返します。

バッファレングス2
[入力]*Description バッファの文字数の長さ。

NameLength2Ptr
[出力]*Descriptionで返せる文字数(null終端文字を除く)を返すためのバッファへのポインタ。 返す文字数が BufferLength2以上の場合、*Description のドライバ記述は BufferLength2 からnull終端文字の長さを引いたものに切り詰められます。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NO_DATA、SQL_ERROR、SQL_INVALID_HANDLE。

Diagnostics

SQLDataSourcesがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、SQLGetDiagRecを呼び出してHandleType(SQL_HANDLE_ENV)とHandle(EnvironmentHandle)を割り当てて対応するSQLSTATE値を取得できます。 以下の表は 、通常SQLDataSources によって返されるSQLSTATE値を示し、それぞれをこの関数の文脈で説明しています。「(DM)」という表記は、ドライバーマネージャーが返すSQLstateの記述の前に記載されます。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

Comments

SQLDataSourcesはドライバーマネージャーで実装されているため、特定のドライバーの標準に準拠しているかどうかに関わらず、すべてのドライバーでサポートされています。

アプリケーションは SQLDataSources を複数回呼び出して、すべてのデータソース名を取得することができます。 ドライバーマネージャーはこの情報をシステム情報から取得します。 データソース名がなくなった場合、ドライバーマネージャーがSQL_NO_DATAを返します。 SQLDataSourcesがSQL_NO_DATAを返した直後にSQL_FETCH_NEXTで呼び出すと、最初のデータソース名を返します。 アプリケーションが SQLDataSourcesから返される情報をどのように利用するかについては、「 データソースまたはドライバーの選択」を参照してください。

SQL_FETCH_NEXTが最初に SQLDataSources に渡された場合、最初のデータソース名が返されます。

ドライバーはデータソース名を実際のデータソースにマッピングする方法を決定します。

関連関数

関連するコンテンツ

• ODBC API リファレンス
• ODBC ヘッダー ファイル