The IB_XMLDA Structure

From InterBase
Jump to: navigation, search

Go Up to Using the InterBase API to Generate XML


The IB_XMLDA structure is contained in the ibxml.h file. It looks like this:

typedef struct ib_xmlda {
char ISC_FAR *xmlda_file_name; /* Points to a char string containing
the name of the file used by xml_fetch();
ignored by the buffer function */
char ISC_FAR *xmlda_header_tag; /* Points to the string which is printed
out as the header tag */
char ISC_FAR *xmlda_database_tag; /* Points to the string that is printed
out as the database tag in the xml file*/
char ISC_FAR *xmlda_table_tag; /* Points to the string that is printed
out as the tablename tag in the
xml file */
char ISC_FAR *xmlda_row_tag; /* Points to the string that is printed
out as the rowname tag in the xml file */
FILE *xmlda_file_ptr; /* Used internally by the API to hold the file pointer; can be POINTER type in non-C, C++ programs */ char ISC_FAR **xmlda_temp_buffer; /* Internal use only, used for storing the string array from fetch() */
ISC_STATUS xmlda_fetch_stat; /* Holds the return value from the
isc_dsql_fetch() call; it indicates whether all the records have been redeived or if there is an error */
ULONG xmlda_flags; /* Flags explained below */
ULONG xmlda_more_data; /* Used by the buffer call to maintain the
status of the last record: 0 if there is no more data, 1 if there is data that has been fetched but not put out in the buffer */
ISC_ULONG xmlda_temp_size; /* Internal use only, stores the size of
the last record */
ISC_USHORT xmlda_status; /* Internal status must be set to 0 by user
when called for the first time */
USHORT xmlda_more; /* Used in conjunction with the buffered
mode; set this if there is more XML data */
USHORT xmlda_version; /* Version of XMLDA */
USHORT xmlda_array_size; /* Internal use only */
SLONG xmlda_reserved; /* Reserved for future use */
} IB_XMLDA;

Topics