16.4.2 SQLDrivers,SQLDriversW
- 〈この項の構成〉
(1) 機能
ドライバ記述とドライバ属性キーワードの一覧を返します。
この関数は,ドライバマネージャで実行できます。HADB ODBCドライバでは,常にSQL_SUCCESSを返す関数としてSQLDriversまたはSQLDriversWを提供しています。
(2) 形式
-
SQLDriversの場合
SQLRETURN SQLDrivers ( SQLHENV EnvironmentHandle, /* In */ SQLUSMALLINT Direction, /* In */ SQLCHAR * DriverDescription, /* Out */ SQLSMALLINT BufferLength1, /* In */ SQLSMALLINT * DescriptionLengthPtr, /* Out */ SQLCHAR * DriverAttributes, /* Out */ SQLSMALLINT BufferLength2, /* In */ SQLSMALLINT * AttributesLengthPtr /* Out */ )
-
SQLDriversWの場合
SQLRETURN SQLDriversW ( SQLHENV EnvironmentHandle, /* In */ SQLUSMALLINT Direction, /* In */ SQLWCHAR * DriverDescription, /* Out */ SQLSMALLINT BufferLength1, /* In */ SQLSMALLINT * DescriptionLengthPtr, /* Out */ SQLWCHAR * DriverAttributes, /* Out */ SQLSMALLINT BufferLength2, /* In */ SQLSMALLINT * AttributesLengthPtr /* Out */ )
(3) 引数
- EnvironmentHandle:
-
環境ハンドルを指定します。
- Direction:
-
ドライバマネージャがデータソースの情報を取得するときの読み込み方式を指定します。次の値を指定できます。
-
SQL_FETCH_FIRST:一覧の先頭からドライバ記述をフェッチします(ユーザDSN,システムDSNの両方)。
-
SQL_FETCH_NEXT:一覧の中の次のドライバ記述をフェッチします。
-
- DriverDescription:
-
ドライバ記述を返すバッファのポインタを指定します。
- BufferLength1:
-
ドライバ記述を返すバッファの長さ※を指定します。
- DescriptionLengthPtr:
-
*DriverDescriptionの有効な長さ※の合計を格納するバッファへのポインタを指定します。この長さにNULL終端文字は含まれません。
- DriverAttributes:
-
ドライバの属性値を格納したバッファのポインタを指定します。
- BufferLength2:
-
ドライバの属性値を返すバッファの長さ※を指定します。
- AttributesLengthPtr:
-
*AttributesLengthPtrの有効な長さ※の合計を格納するバッファへのポインタを指定します。この長さにNULL終端文字は含まれません。
- 注※
-
長さの単位は,SQLDriversの場合はバイト長,SQLDriversWの場合は文字数となります。
(4) 戻り値
SQL_SUCCESSが返されます。
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
SQLSTATE |
説明 |
備考 |
返却 |
---|---|---|---|
01000 |
一般警告 |
− |
× |
01004 |
文字列データの右側が切り捨てられた |
× |
|
HY000 |
一般エラー |
× |
|
HY001 |
メモリ割り当てエラー |
× |
|
HY013 |
メモリ管理エラー |
× |
|
HY090 |
無効な文字列長または無効なバッファ長 |
× |
|
HY103 |
無効な取得コード |
× |
- (凡例)
-
×:HADB ODBCドライバが返さないSQLSTATEです。
−:なし。