TMF Application Programmer's Guide (H06.06+, J06.03+)

TMF ARLIB2 Audit-Reading Procedures
HP NonStop TMF Application Programmer’s Guide—540139-009
5-75
ARGETMXCOLUMNINFO
The definitions of IMAGEINFO and COLUMNINFO are shown in Example 5-1. They
are declared in the ARDDL2 file (and the related AR* files). The values returned in all
the length and offset fields in these structures are in bytes. The order of the columns
reflects the order they were declared in, not their order in the on-disk record, which can
differ from the declared order for SQL/MX objects.
Example 5-1. IMAGEINFO and COLUMNINFO Definitions
efinition IMAGEINFO.
02 COLUMN-COUNT type binary 32,0
02 ENCODEDKEYLENGTH type binary 32,0
02 filler type pic x (120)
02 COLUMNINFO-ARRAY type COLUMNINFO occurs 1 to
MAXMXCOLUMNS times depending on COLUMN-COUNT.
end ! of definition IMAGEINFO
ddefinition COLUMNINFO.
02 COLUMN-NUM type binary 32,0
Column number (same as in SQL/MX metadata tables).
Column number zero is the system key.
02 COLUMN-ANSI-TYPE type binary 32,0
ANSI type code for the data type of the column.
See table 18 in the ANSI SQL92 standard.
02 COLUMN-FS-TYPE type binary 32,0
FS data type of the column. See file sqlcli.h for the _SQLDT_*
defines that describe the codes returned here
02 KEYFLAG type binary 32,0
Set to -1 if this column is not part of the clustering key, set to
the key column position otherwise (first column is column #0).
02 DATAOFFSET type binary 32,0 ! Offset into the Image Record.
Offset in bytes of the data portion of this column. Note that the data
portion does not include the null indicator or the varchar length.
02 DATALENGTH type binary 32,0
Length in bytes of the data portion of this column. The data portion
will occupy DATALENGTH bytes, starting at offset DATAOFFSET.
02 NULLINDOFFSET type binary 32,0
Offset of the NULL indicator of this column in bytes. This value
is undefined if the column is not nullable.
02 NULLINDLENGTH type binary 32,0
Length in bytes of this column's NULL indicator. Value is 0 if the
column is not nullable. Otherwise, the NULL indicator will occupy
NULLINDLENGTH bytes, starting at offset NULLINDOFFSET.
Note that the NULL indicator may or may not be adjacent
to the data portion of the column. This value could be 0, 2, 4, or 8.
02 VARCHARLENOFFSET type binary 32,0
Similar to the NULL indicator, this describes the offset of the
length indicator for varchars (and maybe other variable-length
columns in the future). This value is undefined if the column
does not have a variable length indicator.
02 VARCHARLENLENGTH type binary 32,0 ! Zero if column not varchar.
Size (length) in bytes of the variable length indicator. This value
could be 0, 2, 4, or 8. A value of 0 indicates that the column does
not have a variable length indicator.
02 DATETIME-INTCODE type binary 32,0
Detailed information on datetime or interval ANSI datatypes.
See Tables 19 and 20 in the ANSI SQL92 standard or see the
SQLDTCODE_ and SQLINTCODE_ constants defined in file sqlcli.h.
02 DATETIME-FSCODE type binary 32,0
A more detailed description if COLUMN-FS-TYPE has the value 192
(_SQLDT_DATETIME). This value is sometimes also returned as
"precision" of a datetime value. See the SQLDTCODE_* constants
defined in file sqlcli.h for the values returned. This value is
undefined if COLUMN-FS-TYPE is not _SQLDT_DATETIME.
02 LEADING-PRECISION type binary 32,0
This value is only set for interval data types and indicates the
precision of the leading part of the interval (years, months, etc.).