16.5.3 SQLSetEnvAttr
- 〈この項の構成〉
(1) 機能
環境属性を設定します。
(2) 形式
SQLRETURN SQLSetEnvAttr ( SQLHENV EnvironmentHandle, /* In */ SQLINTEGER Attribute, /* In */ SQLPOINTER ValuePtr, /* In */ SQLINTEGER StringLength /* In */ )
(3) 引数
- EnvironmentHandle：
-
属性を設定する接続の環境ハンドルを指定します。
- Attribute：
-
設定する環境属性を指定します。指定できる属性については，「16.15 SQLSetEnvAttrおよびSQLGetEnvAttrに指定できる属性」を参照してください。
- ValuePtr：
-
Attributeで関連づけられた値を指すポインタまたは32ビット整数値を指定します。指定できる値については，「16.15 SQLSetEnvAttrおよびSQLGetEnvAttrに指定できる属性」を参照してください。
- StringLength：
-
ValuePtrが文字列またはバイナリを指すポインタの場合，*ValuePtrの長さを指定します（単位：バイト長）。ValuePtrが整数の場合，この引数の指定は無視されます。
(4) 戻り値
SQL_SUCCESS，SQL_ERROR，またはSQL_INVALID_HANDLEが返されます。
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
|
SQLSTATE |
説明 |
備考 |
返却 |
|---|---|---|---|
|
01000 |
一般警告 |
− |
× |
|
01S02 |
オプション値の変更 |
× |
|
|
HY000 |
一般エラー |
× |
|
|
HY001 |
メモリ割り当てエラー |
× |
|
|
HY009 |
NULLポインタの不正使用 |
× |
|
|
HY010 |
関数シーケンスエラー |
○ |
|
|
HY011 |
ここでは属性を設定できない |
EnvironmentHandleに接続ハンドルが割り当てられています。 |
× |
|
HY013 |
メモリ管理エラー |
− |
× |
|
HY024 |
無効な属性値 |
Attributeに指定された値に対して，ValuePtrに無効な値が指定されています。 |
○ |
|
HY090 |
無効な文字列長または無効なバッファ長 |
StringLengthに0より小さく，SQL_NTS以外の値が指定されています。 |
○ |
|
HY092 |
無効な属性識別子，または無効なオプション識別子 |
無効なAttributeが指定されています。 |
○ |
|
HY117 |
接続がサスペンド中 |
− |
× |
|
HYC00 |
オプション機能は実装されていない |
指定されたAttributeは，規格にはありますがサポートしていません。 |
○ |
- （凡例）
-
○：HADB ODBCドライバが返すことがあるSQLSTATEです。
×：HADB ODBCドライバが返さないSQLSTATEです。
−：なし。