TXMLBroker.GetXMLRecords Method

Retrieves an XML data packet from the application server.

Pascal

function GetXMLRecords(var RecsOut: Integer; var OwnerData: OleVariant; XMLOptions: TXMLOptions): string;

C++

__fastcall AnsiString GetXMLRecords(int RecsOut, OleVariant OwnerData, TXMLOptions XMLOptions);

Description

Call GetXMLRecords to obtain the XML data packet from the application server. GetXMLRecords calls the interface specified by AppServer, requesting an XML data packet with at most MaxRecords records. It returns the resulting XML data packet in a form that is ready for insertion into an HTML document.

RecsOut returns the number of records in the XML data packet.

On entry, OwnerData contains an application-defined value that is passed to the provider's BeforeGetRecords event handler. OwnerData returns an application-defined value that is set by the provider's AfterGetRecords event handler. Typically, this parameter is used to transmit persistent state information to and from a stateless application server.

XMLOptions is a set of flags that indicate how the broker should format the XML data packet after it is retrieved from the application server.

GetXMLRecords returns the formatted XML data packet.

Note: Unlike the RequestRecords method, GetXMLRecords bypasses the OnRequestRecords event.