19.7.1 a_rdb_SQLColumnInfo_t構造体(列情報)
- 〈この項の構成〉
(1) 機能
a_rdb_SQLColumnInfo_t構造体には,a_rdb_SQLDescribeCols()で取得した検索結果列の情報を格納します。
また,a_rdb_SQLBindCols()による検索結果列の関連づけをする際にもこの構造体を使用します。
a_rdb_SQLDescribeCols()については,「19.4.6 a_rdb_SQLDescribeCols()(検索結果列の情報取得)」を,a_rdb_SQLBindCols()については,「19.4.3 a_rdb_SQLBindCols()(検索結果列の関連づけ)」を参照してください。
(2) 形式
typedef struct a_rdb_TG_ColumnInfo { struct a_rdb_TG_NameInfo *NameInfo ; /* Out */ struct a_rdb_TG_DataType *TypeInfo ; /* Out */ unsigned short Nullable ; /* Out */ char _ColumnInfo_rsv01[2] ; signed int StrLen_or_Ind ; /* Out */ void *TargetValue ; /* Out */ unsigned int BufferLength ; /* In */ char _ColumnInfo_rsv02[28] ; } a_rdb_SQLColumnInfo_t ;
(3) メンバの説明
- NameInfo:
-
検索結果列の列名に関する情報を取得するアドレスを指定します。
列記述を実行する場合に指定してください。列結合を実行する場合に指定しても無視されます。
0を指定した場合は,情報は取得しません。
- TypeInfo:
-
検索結果列のデータ型に関する情報を取得するアドレスを指定します。
列記述を実行する場合に指定してください。列結合を実行する場合に指定しても無視されます。
0を指定した場合は,情報は取得しません。
- Nullable:
-
検索結果列にナル値が返却される可能性があるかどうかを返します。
-
ナル値を返却する可能性がない場合:a_rdb_SQL_IS_NOT_NULLABLE
-
ナル値を返却する可能性がある場合:a_rdb_SQL_IS_NULLABLE
列記述を実行する場合にこれらの値が設定されます。
-
- StrLen_or_Ind:
-
値の長さまたはインジケータ値のどちらかを取得します。
行を取り出した際に値が設定されます。
- TargetValue:
-
値を設定するアドレスを指定します。値は,SQLのデータ型に対応するC言語またはC++言語のデータ記述で指定します。
SQLのデータ型に対応するC言語またはC++言語のデータ記述については,「19.6.2 SQLのデータ型とデータ記述の対応」を参照してください。
列結合を実行する場合に指定してください。列記述を実行する場合に指定しても無視されます。
- BufferLength:
-
値を設定する領域の長さを指定します。
データの領域長については,「19.6.2 SQLのデータ型とデータ記述の対応」を参照してください。
列結合を実行する場合に指定してください。列記述を実行する場合に指定しても無視されます。
(4) 留意事項
a_rdb_SQLColumnInfo_t構造体を使用する場合,最初に領域を0で初期化してください。そのあとで,使用する各メンバに値を指定してください。