SQLDataSources 関数

準拠
導入されたバージョン: ODBC 1.0 Standards Compliance: ISO 92

まとめ
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 をフェッチする場合) をSQL_FETCH_FIRST_USERします。

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

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

ServerName が NULL の場合、NameLength1Ptr は引き続き、ServerName が指すバッファーで返すために使用できる文字数 (文字データの null 終端文字を除く) を返します。

BufferLength1
[入力]*ServerName バッファーの長さ (文字数)。これは、SQL_MAX_DSN_LENGTHに null 終端文字を加えたものより長くする必要はありません。

NameLength1Ptr
[出力]*ServerName で返すために使用できる文字数 (null 終了文字を除く) を返すバッファーへのポインター。 返される文字数が BufferLength1 以上の場合、*ServerName のデータ ソース名は BufferLength1 から null 終端文字の長さを引いた値に切り捨てられます。

説明
[出力]データ ソースに関連付けられているドライバーの説明を返すバッファーへのポインター。 たとえば、dBASE や SQL Serverなどです。

Description が NULL の場合、NameLength2Ptr は引き続き Description が指すバッファーで返すために使用できる文字数 (文字データの null 終端文字を除く) を返します。

BufferLength2
[入力]*Description バッファーの文字数。

NameLength2Ptr
[出力]*Description で返すために使用できる文字数 (null 終了文字を除く) を返すバッファーへのポインター。 返される文字数が BufferLength2 以上の場合、*Description のドライバーの説明は BufferLength2 から null 終端文字の長さを引いた値に切り捨てられます。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NO_DATA、SQL_ERROR、またはSQL_INVALID_HANDLE。

診断

SQLDataSources が SQL_ERROR または SQL_SUCCESS_WITH_INFO を返す場合は、関連付けられている SQLSTATE 値を取得するには、HandleType が SQL_HANDLE_ENV で、Handle of EnvironmentHandle を指定して SQLGetDiagRec を呼び出します。 次の表に、 SQLDataSources によって通常返される SQLSTATE 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。"(DM)" という表記は、ドライバー マネージャーによって返される SQLSTATEs の説明の前にあります。 特に明記されていない限り、各 SQLSTATE 値に関連付けられた戻りコードはSQL_ERRORされます。

説明

SQLDataSources はドライバー マネージャーに実装されているため、特定のドライバーの標準準拠に関係なく、すべてのドライバーでサポートされます。

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

SQL_FETCH_NEXTが初めて呼び出されるときに SQLDataSources に渡された場合、最初のデータ ソース名が返されます。

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

関連する関数

参照

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