Datasnap.Provider.TDataSetProvider.CreateDataPacket

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type:
procedure
function
Visibility: protected
Source:
Datasnap.Provider.pas
Datasnap.Provider.hpp
Unit: Datasnap.Provider
Parent: TDataSetProvider

Delphi

procedure CreateDataPacket(PacketOpts: TGetRecordOptions;
ProvOpts: TProviderOptions; var RecsOut: Integer; var Data: OleVariant); override;

C++

virtual void __fastcall CreateDataPacket(TGetRecordOptions PacketOpts, TProviderOptions ProvOpts, int &RecsOut, System::OleVariant &Data);

Description

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

CreateDataPacket is used internally to generate 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 any 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