16.5.6 SQLGetStmtAttr，SQLGetStmtAttrW
- 〈この項の構成〉
(1) 機能
ステートメントハンドルに設定されている属性の値を返します。
(2) 形式
-
SQLGetStmtAttrの場合
SQLRETURN SQLGetStmtAttr ( SQLHSTMT StatementHandle, /* In */ SQLINTEGER Attribute, /* In */ SQLPOINTER ValuePtr, /* Out */ SQLINTEGER BufferLength, /* In */ SQLINTEGER * StringLengthPtr /* Out */ )
-
SQLGetStmtAttrWの場合
SQLRETURN SQLGetStmtAttrW ( SQLHSTMT StatementHandle, /* In */ SQLINTEGER Attribute, /* In */ SQLPOINTER ValuePtr, /* Out */ SQLINTEGER BufferLength, /* In */ SQLINTEGER * StringLengthPtr /* Out */ )
(3) 引数
- StatementHandle：
-
ステートメントハンドルを指定します。
- Attribute：
-
取得する属性を指定します。指定できる属性については，「16.16 SQLSetStmtAttr，SQLSetStmtAttrW，SQLGetStmtAttrおよびSQLGetStmtAttrWに指定できる属性」を参照してください。
- ValuePtr：
-
Attributeで指定された属性の値を返すバッファのポインタを指定します。ValuePtrにはNULLも指定できます。
- BufferLength：
-
Attributeに指定された属性の値の型が，文字列またはバイナリの場合，*ValuePtrの長さを指定します（単位：バイト長）。それ以外のデータ型の場合，この引数の指定は無視されます。
- StringLengthPtr：
-
返した属性の値の有効なバイト長の合計が格納されるバッファのポインタを指定します。このバイト長の合計にNULL終端文字のバイト長は含みません。ValuePtrがNULLの場合，*StringLengthPtrに値は返されません。
(4) 戻り値
SQL_SUCCESS，SQL_ERROR，またはSQL_INVALID_HANDLEが返されます。
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
|
SQLSTATE |
説明 |
備考 |
返却 |
|---|---|---|---|
|
01000 |
一般警告 |
− |
× |
|
24000 |
無効なカーソル状態 |
× |
|
|
HY000 |
一般エラー |
× |
|
|
HY001 |
メモリ割り当てエラー |
× |
|
|
HY010 |
関数シーケンスエラー |
○ |
|
|
HY013 |
メモリ管理エラー |
× |
|
|
HY090 |
無効な文字列長または無効なバッファ長 |
× |
|
|
HY092 |
無効な属性識別子，または無効なオプション識別子 |
○ |
|
|
HY109 |
無効なカーソル位置 |
× |
|
|
HYC00 |
オプション機能は実装されていない |
○ |
|
|
HYT01 |
接続タイムアウト終了 |
× |
|
|
IM001 |
ドライバはこの関数をサポートしていない |
× |
- （凡例）
-
○：HADB ODBCドライバが返すことがあるSQLSTATEです。
×：HADB ODBCドライバが返さないSQLSTATEです。
−：なし。