RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TXMLBroker.RequestRecords Method

Returns an XML data packet from the application server.

Pascal
function RequestRecords(Sender: TObject; Request: TWebRequest; out RecCount: Integer; var OwnerData: OleVariant; XMLOptions: TXMLOptions): string; virtual;
C++
virtual __fastcall AnsiString RequestRecords(TObject * Sender, TWebRequest Request, int RecCount, OleVariant OwnerData, TXMLOptions XMLOptions);

Call RequestRecords to obtain a current XML data packet, while first allowing the OnRequestRecords event handler to customize it. After generating the OnRequestRecords event, RequestRecords fetches the XML data packet by calling GetXMLRecords, unless the event handler supplies the XML data packet first. 

Sender is the object that is requesting the XML data packet (usually an InternetExpress page producer). 

Request describes an HTTP request message that originated the need for an XML data packet. Typically, this is a request message for which the InternetExpress page producer is creating a response. 

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

On entry, OwnerData contains an application-defined value that is passed to the OnRequestRecords event handler, and then forwarded (with any changes provided by the event handler) 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 indicating how the XML broker should format the XML data packet that the application server or OnRequestRecords event handler supplies. 

RequestRecords returns the XML data packet. 

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!