Export_to_XML_buffer

C/C++Pascal

BOOL Export_to_XML_buffer(cdp_t cdp, const char * dad_ref, char * buffer, int buff_size, int * xmlsize, tcursnum curs, struct t_clivar * hostvars, int hostvars_count);
function Export_to_XML_buffer(cdp : cdp_t; dad_ref, buffer : PChar; buff_size : Integer; var xmlsize : Integer; curs : tcursnum; hostvars : ^t_clivar; hostvars_count : Integer) : Boolean;


Parametry

cdp
context variable of the client
dad_ref
reference to DAD
fname
name of the XML file
buffer
output parameter where XML output is written
buff_size
size of the buffer variable
xmlsize
output parameter specifying the actual size of exported XML
curs
opened cursor or -1
hostvars
array describing the client variables
hostvars_count
number of hostvars array values


Od verze

8.1

Popis

This function exports data specified in the DAD to XML format in a string variable buffer. If the size of the buffer variable (the buff_size value) is less than the XML output size, the output in the buffer variable will be incomplete. If xmlsize>buff_size, you will need to repeat the export into a larger buffer.

In the case of an analytic DAD, the data source is fixed in the DAD description (curs = -1). In the case of a synthetic DAD, you may use the DAD description (curs = -1) or use your own cursor from the same structure (set the curs number to that cursor).

The dad_ref parameter may have two forms. If it is in the object_name prefixed with an asterisk (*object_name), the DAD will search the current opened application for a transfer type object, otherwise it is read from the specified variable.

You may pass client application variable descriptions using the hostvars array. These variables may be used in a query as a data source in the DAD or as variables bound to an element in the DAD. The hostvars_count parameter contains the number of the passed variables. If you do not use this leave hostvars_count = 0.

You may also use the Export_to_XML_CLOB function for the same result.



Návratová hodnota

TRUE if successful, otherwise FALSE.

Viz