RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TBaseProvider.CreateDataPacket Method
TBaseProvider Class | TBaseProvider Members | Provider Namespace | Description | See Also
Collapse All

Generates a data packet for the data associated with the provider.

Pascal
procedure CreateDataPacket(PacketOpts: TGetRecordOptions; ProvOpts: TProviderOptions; var RecsOut: Integer; var Data: OleVariant); virtual;
C++
virtual __fastcall CreateDataPacket(TGetRecordOptions PacketOpts, TProviderOptions ProvOpts, int RecsOut, OleVariant Data);
Description

CreateDataPacket is used internally to generate data packets. As implemented in TBaseProvider, CreateDataPacket sets RecsOut to 0 and Data to NULL. Descendants override this method to create the data packets that are returned by GetRecords. 

The PacketOpts parameter indicates what information (other than record values) is included in the data packet. It reflects the Options passed to the GetRecords method. 

The ProvOpts parameter reflects the current value of the Options property. 

The RecsOut parameter specifies the number of records desired in the packet and returns the actual number of records in the generated data packet. 

The Data parameter returns the generated data packet. 

 

See Also
Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!