16.5.4 SQLGetEnvAttr
- 〈この項の構成〉
(1) 機能
環境ハンドルの属性に設定されている値を返します。
(2) 形式
SQLRETURN SQLGetEnvAttr ( SQLHENV EnvironmentHandle, /* In */ SQLINTEGER Attribute, /* In */ SQLPOINTER ValuePtr, /* Out */ SQLINTEGER BufferLength, /* In */ SQLINTEGER * StringLengthPtr /* Out */ )
(3) 引数
- EnvironmentHandle：
-
環境ハンドルを指定します。
- Attribute：
-
取得する属性を指定します。指定できる属性については，「16.15 SQLSetEnvAttrおよびSQLGetEnvAttrに指定できる属性」を参照してください。
- 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 |
一般警告 |
− |
× |
|
01004 |
文字列データの右側が切り捨てられた |
× |
|
|
HY000 |
一般エラー |
× |
|
|
HY001 |
メモリ割り当てエラー |
× |
|
|
HY010 |
関数シーケンスエラー |
○ |
|
|
HY013 |
メモリ管理エラー |
× |
|
|
HY092 |
無効な属性識別子，または無効なオプション識別子 |
○ |
|
|
HYC00 |
オプション機能は実装されていない |
○ |
|
|
IM001 |
ドライバはこの関数をサポートしていない |
× |
- （凡例）
-
○：HADB ODBCドライバが返すことがあるSQLSTATEです。
×：HADB ODBCドライバが返さないSQLSTATEです。
−：なし。