OpenAPI User Guide > OpenAPI User Guide > OpenAPI Data Types > OpenAPI Data Structures > IIAPI_FDATADESCR Data Type--Describe Column Data in a Copy File
Was this helpful?
IIAPI_FDATADESCR Data Type--Describe Column Data in a Copy File
This data type describes the data in a copy file. It also describes how the file should be formatted.
This data type has the following syntax:
typedef struct _IIAPI_FDATADESCR
{
       II_CHAR *fd_name;
       II_INT2 fd_type;
       II_INT2 fd_length;
       II_INT2 fd_prec;
       II_LONG fd_column;
       II_LONG fd_funcID;
       II_LONG fd_cvLen;
       II_LONG fd_cvPrec;
       II_BOOL fd_delimiter;
       II_INT2 fd_delimLength;
       II_CHAR *fd_delimValue;
       II_BOOL fd_nullable;
       II_BOOL fd_nullInfo;
       IIAPI_DESCRIPTOR fd_nullDescr;
IIAPI_DATAVALUE fd_nullValue;
} IIAPI_FDATADESCR;
This data type has the following parameters:
fd_name
Specifies the name of the column in the file.
fd_type
Specifies the datatype of the column as stored in the file.
fd_length
Specifies the length of the column as stored in the file.
fd_prec
Specifies the encoded precision and scale of the column as stored in the file.
fd_column
Specifies the index in cp_dbmsDescr of the corresponding column in the table (see IIAPI_COPYMAP).
fd_funcID
Specifies an Ingres Abstract Data Facility function ID used for conversion between the table column datatype and file datatype.
fd_cvLen
Specifies the length used during conversion.
fd_cvPrec
Specifies the encoded precision and scale used during conversion.
fd_delimiter
Indicates whether a separator is used between columns. This parameter is TRUE if there is a separator between this and the next column; otherwise, it is FALSE.
fd_delimLength
Specifies the length of the separator between this and the next column. This parameter is valid only if fd_isDelimiter is TRUE.
fd_delimValue
Specifies the value of the separator between this and the next column. This parameter is valid only if fd_isDelimiter is TRUE.
fd_nullable
Indicates whether a NULL value is allowed in the column. This parameter is TRUE if NULL is allowed; otherwise, it is FALSE.
fd_nullInfo
Indicates whether a symbol representing a NULL value should be specified for this column. If so, this parameter is TRUE; otherwise, it is FALSE. This parameter is valid only if fd_nullable is TRUE.
fd_nullDescr
Specifies the description of the NULL symbol. This parameter is valid if fd_nullable and fd_nullInfo are TRUE.
fd_nullValue
Specifies the value of the NULL symbol. This parameter is valid if fd_nullable and fd_nullInfo are TRUE.
Last modified date: 11/28/2023