SQLGetEnvAttr 関数

適合 性
導入バージョン:ODBC 3.0 規格準拠:ISO 92

Summary
SQLGetEnvAttr は環境属性の現在の設定を返します。

構文

  
SQLRETURN SQLGetEnvAttr(  
     SQLHENV        EnvironmentHandle,  
     SQLINTEGER     Attribute,  
     SQLPOINTER     ValuePtr,  
     SQLINTEGER     BufferLength,  
     SQLINTEGER *   StringLengthPtr);  

引数

EnvironmentHandle
[入力]環境の取り扱い。

属性
[入力]取得する属性。

ValuePtr
[出力]属性 で指定された属性の現在の値を返すためのバッファへのポインタ。

ValuePtr が NULL の場合、StringLengthPtr は ValuePtr が指すバッファ内で返せる合計バイト数(文字データの null 終端文字を除く)を返します。

BufferLength
[入力]もし ValuePtr が文字文字列を指すなら、この引数は*ValuePtrの長さであるべきです。 *ValuePtr が整数の場合、 BufferLength は無視されます。 * ValuePtr がUnicode文字列( SQLGetEnvAttrWを呼び出す際)であれば、 BufferLength の引数は偶数でなければなりません。 属性値が文字列でない場合、 BufferLength は使われません。

StringLengthPtr
[出力]* ValuePtrで返せる(null終端文字を除く)合計バイト数を返すバッファへのポインタです。 属性値が文字文字列で、返す可能なバイト数が BufferLength以上であれば、*ValuePtr のデータはヌル終端文字の長さを引いた BufferLength に切り詰められ、ドライバーによってnull終端処理されます。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NO_DATA、SQL_ERROR、SQL_INVALID_HANDLE。

Diagnostics

SQLGetEnvAttrがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返すと、SQLGetDiagRecを呼び出し、HandleTypeをSQL_HANDLE_ENV、HandleをenvironmentHandleで呼び出すことで関連するSQLSTATE値を取得できます。 以下の表は 、SQLGetEnvAttr が通常返すSQLSTATE値を示し、それぞれをこの関数の文脈で説明しています。「(DM)」という表記は、ドライバーマネージャーが返すSQLstateの記述の前に記載されます。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

Comments

属性の一覧については 、SQLSetEnvAttrを参照してください。 ドライバー固有の環境属性はありません。 Attributeが文字列を返す属性を指定する場合、ValuePtrは文字列を返すバッファへのポインタでなければなりません。 文字列の最大長(null終端バイトを含む)は BufferLength バイトとなります。

SQLGetEnvAttr は、割り当てから環境ハンドルの解放までの任意のタイミングで呼び出すことができます。 アプリケーションが環境に対して正しく設定したすべての環境属性は、HandleTypeのHandleをSQL_HANDLE_ENVでEnvironmentHandle上で呼び出しるまで保持されます。 ODBC 3*.x*では複数の環境ハンドルを同時に割り当てることができます。 ある環境の環境属性は、別の環境が割り当てられても影響を受けません。

関連関数

関連するコンテンツ

• ODBC API リファレンス
• ODBC ヘッダー ファイル