SQLColAttributes() - 列属性を取得する

SQLColAttributes() は使用すべきでない関数です。これは SQLColAttribute() に置き換えられます。

SQLColAttributes() の ODBC 仕様

表 1. SQLColAttributes() の仕様
ODBC 仕様レベル X/Open CLI CAE 仕様 ISO CLI 仕様
1.0 (「使用すべきでない」) なし なし

構文

SQLRETURN   SQLColAttributes (SQLHSTMT          hstmt,
                              SQLUSMALLINT      icol,
                              SQLUSMALLINT      fDescType,
                              SQLPOINTER        rgbDesc,
                              SQLSMALLINT       cbDescMax,
                              SQLSMALLINT FAR   *pcbDesc,
                              SQLINTEGER  FAR   *pfDesc);

関数の引数

次の表は、この関数のそれぞれの引数ごとに、 データ・タイプ、用途、および説明を示しています。

表 2. SQLColAttributes() の引数
データ・タイプ 引数 使用法 説明
SQLHSTMT hstmt 入力 ステートメント・ハンドル。
SQLUSMALLINT icol 入力 結果セット内の列番号 (1 から結果セットに含まれる列の数まで)。 この引数は、SQL_COLUMN_COUNT を指定すると無視されます。
SQLUSMALLINT fDescType 入力 サポートされる値は SQLColAttribute() 関数の説明に示されています。
SQLCHAR * rgbDesc 出力 ストリング列属性用のバッファーを指すポインター。
SQLSMALLINT cbDescMax 入力 記述子バッファー rgbDesc の長さ (バイト) を指定します。
SQLSMALLINT * pcbDesc 出力 rgbDesc バッファーに戻される実際のバイト数。 この引数が、cbDescMax に指定されている長さに等しいか それより大きい値の場合は切り捨てられます。 これによって、列属性値は、cbDescMax バイトから NUL 終止符のサイズを引いた 値 (または、NULL 終了がオフの場合は、cbDescMax バイト) に切り捨てられます。
SQLINTEGER * pfDesc 出力 数字列属性の値を持つ整数を指すポインター。