XSQLVAR Field Descriptions

From InterBase
Jump to: navigation, search

Go Up to Understanding the XSQLDA


The following table describes the fields of the XSQLVAR structure:

Field definition Description

short sqltype

Indicates the SQL data type of parameters or select-list items; set by InterBase during isc_dsql_describe(), ­isc_dsql_describe_bind(), or isc_dsql_prepare().

short sqlscale

Provides scale, specified as a negative number, for exact numeric data types (DECIMAL and NUMERIC); set by InterBase during isc_dsql_describe(), ­isc_dsql_describe_bind(), or isc_dsql_prepare().

short sqlprecision

Provides precision for the exact numeric data types (DECIMAL and NUMERIC); set by InterBase during isc_dsql_describe(), isc_dsql_describe_bind(), or isc_dsql_prepare().

short sqlsubtype

Specifies the subtype for Blob data; set by InterBase during isc_dsql_describe(), ­isc_dsql_describe_bind(), or isc_dsql_prepare().

short sqllen

Indicates the maximum size, in bytes, of data in the sqldata field; set by InterBase during isc_dsql_describe(), ­isc_dsql_describe_bind(), or isc_dsql_prepare().

char *sqldata

For input descriptors, specifies either the address of a select-list item or a parameter; set by the application.

For output descriptors, contains a value for a select-list item; set by InterBase.

short *sqlind

On input, specifies the address of an indicator variable; set by an application; on output, specifies the address of column indicator value for a select-list item following a FETCH.

A value of >= 0 indicates that the column is not NULL; a value of < 0 indicates the column is NULL; set by InterBase. For additional information about how to interpret this value for InterBase Change Views, please refer to Change Views API Support.

short sqlname_length

Specifies the length, in bytes, of the data in field, sqlname; set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

char sqlname[METADATALENGTH]

Contains the name of the column. Not NULL (\0) terminated; set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

short relname_length

Specifies the length, in bytes, of the data in field, relname; set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

char relname[METADATALENGTH]

Contains the name of the table; not NULL (\0) terminated, set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

short ownname_length

Specifies the length, in bytes, of the data in field, ownname; set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

char ownname[METADATALENGTH]

Contains the name of the table owner; not NULL (\0) terminated, set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

short aliasname_length

Specifies the length, in bytes, of the data in field, aliasname; set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

char aliasname[METADATALENGTH]

Contains the alias name of the column. If no alias exists, contains the column name; not NULL (\0) terminated, set by InterBase during isc_dsql_prepare() or ­isc_dsql_describe().

Advance To: