16.5.2 SQLGetConnectAttr，SQLGetConnectAttrW
(1) 機能
接続ハンドルの属性に設定されている値を返します。
(2) 形式
-
SQLGetConnectAttrの場合
SQLRETURN SQLGetConnectAttr ( SQLHDBC ConnectionHandle, /* In */ SQLINTEGER Attribute, /* In */ SQLPOINTER ValuePtr, /* Out */ SQLINTEGER BufferLength, /* In */ SQLINTEGER * StringLengthPtr /* Out */ )
-
SQLGetConnectAttrWの場合
SQLRETURN SQLGetConnectAttrW ( SQLHDBC ConnectionHandle, /* In */ SQLINTEGER Attribute, /* In */ SQLPOINTER ValuePtr, /* Out */ SQLINTEGER BufferLength, /* In */ SQLINTEGER * StringLengthPtr /* Out */ )
(3) 引数
- ConnectionHandle：
-
接続ハンドルを指定します。
- Attribute：
-
取得する属性を指定します。指定できる属性については，「16.14 SQLSetConnectAttr，SQLSetConnectAttrW，SQLGetConnectAttrおよびSQLGetConnectAttrWに指定できる属性」を参照してください。
- ValuePtr：
-
Attributeで指定された属性の値を返すバッファのポインタを指定します。ValuePtrにはNULLも指定できます。
- BufferLength：
-
Attributeに指定された属性の値の型が，文字列またはバイナリの場合，*ValuePtrの長さ（単位：バイト長）を指定します。それ以外のデータ型の場合，この引数の指定は無視されます。
- StringLengthPtr：
-
返した属性の値の有効な長さ（単位：バイト長）の合計を格納するバッファへのポインタを指定します。この長さにNULL終端文字は含まれません。
ValuePtrがNULLの場合，*StringLengthPtrに値は返されません。
(4) 戻り値
SQL_SUCCESS，SQL_NO_DATA，SQL_ERROR，またはSQL_INVALID_HANDLEが返されます。
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
|
SQLSTATE |
説明 |
備考 |
返却 |
|---|---|---|---|
|
01000 |
一般警告 |
− |
× |
|
01004 |
文字列データの右側が切り捨てられた |
× |
|
|
08003 |
接続が存在しない |
○ |
|
|
08S01 |
通信リンク失敗 |
× |
|
|
HY000 |
一般エラー |
× |
|
|
HY001 |
メモリ割り当てエラー |
× |
|
|
HY010 |
関数シーケンスエラー |
○ |
|
|
HY013 |
メモリ管理エラー |
× |
|
|
HY090 |
無効な文字列長または無効なバッファ長 |
× |
|
|
HY092 |
無効な属性識別子，または無効なオプション識別子 |
○ |
|
|
HYC00 |
オプション機能は実装されていない |
○ |
|
|
HYT01 |
接続タイムアウト終了 |
× |
|
|
IM001 |
ドライバはこの関数をサポートしていない |
× |
- （凡例）
-
○：HADB ODBCドライバが返すことがあるSQLSTATEです。
×：HADB ODBCドライバが返さないSQLSTATEです。
−：なし。
(6) 注意事項
ODBC規約に存在しないHADB独自のAttributeを指定する場合は，adbodb.hをincludeしてください。