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
kontextová proměnná klienta
dad_ref
odkaz na DAD
fname
jméno XML souboru
buffer
výstupní parametr, do něhož se zapíše XML výstup
buff_size
velikost proměnné buffer
xmlsize
výstupní parametr - skutečná velikost vyexportovaného XML
curs
otevřený kurzor nebo -1
hostvars
pole popisující proměnné klienta
hostvars_count
počet složek pole hostvars


Od verze

8.1, úprava 10.0

Popis

Funkce provede export dat uvedených v DAD v XML formátu do řetězcové proměnné buffer. Je-li velikost proměnné buffer (tj. hodnota buff_size) menší než je velikost XML výstupu, bude výstup v proměnné buffer nekompletní. Tento stav se rozpozná porovnáním hodnoty xmlsize, která obsahuje skutečnou velikost výstupu, s hodnotou buff_size. Je-li xmlsize>buff_size, je třeba export opakovat do většího bufferu.

V případě analytického DAD je zdroj dat pevně dán popisem v DAD, proto ponechte hodnotu curs = -1. V případě syntetického DAD je možno využít popisu v DAD, pak ponechte curs = -1, nebo použijte přesměrování na vlastní otevřený kurzor shodné struktury, pak v parametru curs zadejte číslo tohoto kurzoru.

Parametr dad_ref může mít dvě podoby. Je-li ve tvaru jméno_objektu uvozené hvězdičkou (*jméno_objektu), hledá se DAD v otevřené aplikaci jako objekt typu přenos, jinak se čte přímo z paměti.

Pomocí pole hostvars lze předat popis proměnných klientské aplikace, které mohou být použity v dotazu uvedeném jako zdroj dat v DAD nebo jako proměnné, navázané na určitý element DADu. Parametr hostvars_count obsahuje počet takto předávaných proměnných. Pokud proměnné nepoužíváte, uveďte hostvars_count rovno nule.

Vede-li DAD do ODBC zdroje dat (od verze 10), pak spojení na tento ODBC zdroj musí být předem otevřeno pomocí funkce ODBC_connect. Vede-li DAD do jiného 602SQL serveru, musí být spojení na tento server předem otevřeno pomocí connect.

V jazyce SQL lze pro tentýž účel použít jednodušší funkci Export_to_XML_CLOB.



Návratová hodnota

Funkce vrací TRUE při úspěchu a FALSE při chybě.

Viz