SQLGetStmtAttr 関数

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

Summary
SQLGetStmtAttr はステートメント属性の現在の設定を返します。

構文

  
SQLRETURN SQLGetStmtAttr(  
     SQLHSTMT        StatementHandle,  
     SQLINTEGER      Attribute,  
     SQLPOINTER      ValuePtr,  
     SQLINTEGER      BufferLength,  
     SQLINTEGER *    StringLengthPtr);  

引数

StatementHandle
[入力]ステートメント ハンドル。

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

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

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

BufferLength
[入力] Attribute が ODBC で定義された属性で、 ValuePtr が文字列またはバイナリ バッファーを指している場合、この引数の長さは *ValuePtr にする必要があります。 AttributeがODBCで定義された属性で、*ValuePtr が整数の場合、BufferLengthは無視されます。 *ValuePtrで返される値がUnicode文字列(SQLGetStmtAttrWを呼び出す際)であれば、BufferLength引数は偶数でなければなりません。

Attributeがドライバー定義属性の場合、アプリケーションはBufferLength引数を設定してDriver Managerに属性の性質を示します。 BufferLength は以下の値を持つことができます:

• もし *ValuePtr が文字文字列へのポインタであれば、 BufferLength はその文字列または SQL_NTS の長さです。

• もし *ValuePtr がバイナリバッファへのポインタであれば、アプリケーションはSQL_LEN_BINARY_ATTR(length)マクロの結果を BufferLengthに配置します。 これにより BufferLengthに負の値が割り当てられます。

• もし *ValuePtr が文字文字列やバイナリ文字列以外の値へのポインタであれば、 BufferLength は値 SQL_IS_POINTER を持つはずです。

• もし *ValuePtr が固定長のデータ型を含む場合、 BufferLength は適切な形で、SQL_IS_INTEGERまたはSQL_IS_UINTEGERのいずれかです。

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

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

Diagnostics

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

Comments

文属性に関する一般的な情報については、 文属性を参照してください。

SQLGetStmtAttrへの呼び出しは、*ValuePtrでAttributeで指定されたステートメント属性の値を返します。 その値はSQLULEN値か、null終端文字文字列のいずれかである場合があります。 値がSQLULENの価値であれば、一部のドライバーはバッファの下位32ビットまたは16ビットのみを書き込み、高位ビットは変更しないことがあります。 したがって、アプリケーションはSQLulenのバッファを使用し、この関数を呼び出す前に値を0に初期化する必要があります。 また、 BufferLength と StringLengthPtr の引数は使用されません。 値がnull終端文字列の場合、アプリケーションは BufferLength 引数でその文字列の最大長さを指定し、ドライバーは *StringLengthPtr バッファ内のその文字列の長さを返します。

SQLGetStmtAttrを呼び出すアプリケーションがODBC 2と連携できるようにするためです。x driversの場合、SQLGetStmtAttrへの呼び出しはDriver ManagerでSQLGetStmtOptionにマッピングされます。

以下の文属性は読み取り専用であるため、 SQLGetStmtAttrで取得できますが、 SQLSetStmtAttrでは設定できません。

• SQL_ATTR_IMP_PARAM_DESC

• SQL_ATTR_IMP_ROW_DESC

• SQL_ATTR_ROW_NUMBER

設定および取得可能な属性のリストについては、 SQLSetStmtAttrを参照してください。

関連関数

関連するコンテンツ

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