仕様: | DB2 CLI 2.1 |
| ISO CLI |
SQLGetEnvAttr() は、指定された環境属性の現行設定を戻します。
これらのオプションは、SQLSetEnvAttr() 関数を使用して設定されます。
構文
SQLRETURN SQLGetEnvAttr ( SQLHENV EnvironmentHandle, /* henv */ SQLINTEGER Attribute, SQLPOINTER ValuePtr, /* Value */ SQLINTEGER BufferLength, SQLINTEGER *FAR StringLengthPtr); /* StringLength */
関数引き数
データ・タイプ | 引き数 | 使用法 | 説明 |
---|---|---|---|
SQLHENV | EnvironmentHandle | 入力 | 環境ハンドル |
SQLINTEGER | Attribute | 入力 | 受け取る属性。環境属性とその説明のリストについては、『環境属性』を参照してください。 |
SQLPOINTER | ValuePtr | 出力 | Attribute に関連した現行値。戻される値のタイプは、Attribute により異なります。 |
SQLINTEGER | BufferLength | 入力 | ValuePtr が指すバッファーの最大サイズ。属性値は文字ストリングで、それ以外は無視されます。 |
SQLINTEGER * | StringLengthPtr | 出力 | ValuePtr に戻すために使用できる総バイト数 (ヌル終了文字に戻されるバイト数を除く) を戻すバッファーを指すポインター。 ValuePtr がヌル・ポインターの場合、長さは戻されません。属性値が文字ストリングで、戻りに使用できるバイト数が BufferLength 以上の場合、 ValuePtr は BufferLength からヌル終了文字の長さを引いた長さまで切り捨てられ、 DB2 CLI によりヌル終了させられます。 |
Attribute がストリングを示さない場合、DB2 CLI は BufferLength を無視し、 StringLengthPtr を設定しません。
使用法
環境ハンドルの割り振りから解放までの間にいつでも SQLGetEnvAttr() を呼び出すことができます。この関数は、環境属性の現行値を取得します。
有効な環境属性のリストは、『環境属性』を参照してください。
戻りコード
診断
SQLSTATE | 説明 | 解説 |
---|---|---|
HY001 | メモリーの割り振り失敗です。 | DB2 CLI は、関数の実行または完了をサポートするのに必要なメモリーを割り振ることができません。 |
HY092 | オプション・タイプが範囲外です。 | 無効な Attribute 値を指定しました。 |
制約
なし。
(ここで完全サンプル apinfo.c を使用することもできます 。)
/* From the CLI sample APINFO.C */ /* ... */ sqlrc = SQLGetEnvAttr( henv, SQL_ATTR_OUTPUT_NTS, &output_nts, 0, NULL ) ; ENV_HANDLE_CHECK( henv, sqlrc) ;
参照