16.4.4 SQLGetFunctions
- 〈この項の構成〉
(1) 機能
指定したODBC関数がサポートされているかどうかの情報,または各ODBC関数のサポート情報の一覧を返します。
(2) 形式
SQLRETURN SQLGetFunctions ( SQLHDBC ConnectionHandle, /* In */ SQLUSMALLINT FunctionId, /* In */ SQLUSMALLINT * SupportedPtr /* Out */ )
(3) 引数
- ConnectionHandle:
-
接続ハンドルを指定します。
- FunctionId:
-
全関数のサポート情報リストを取得したい場合は,SQL_API_ODBC3_ALL_FUNCTIONSを指定します。
関数単体のサポート情報を取得したい場合は,調査対象のODBC関数の#define値を指定します。
- SupportedPtr:
-
取得したい関数のサポート情報を返すバッファのポインタを指定します。
FunctionIdにODBC関数の#define値を指定した場合,SQL_TRUE(サポートされている)またはSQL_FALSE(サポートされていない)が返されます。
SupportedPtrにはNULLも指定できます。
(4) 戻り値
SQL_SUCCESS,SQL_ERROR,またはSQL_INVALID_HANDLEが返されます。
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
SQLSTATE |
説明 |
備考 |
返却 |
---|---|---|---|
01000 |
一般警告 |
− |
× |
08S01 |
通信リンク失敗 |
× |
|
HY000 |
一般エラー |
× |
|
HY001 |
メモリ割り当てエラー |
× |
|
HY010 |
関数シーケンスエラー |
○ |
|
HY013 |
メモリ管理エラー |
× |
|
HY095 |
関数型が範囲外である |
○ |
|
HYT01 |
接続タイムアウト終了 |
× |
- (凡例)
-
○:HADB ODBCドライバが返すことがあるSQLSTATEです。
×:HADB ODBCドライバが返さないSQLSTATEです。
−:なし。