From RAD Studio API Documentation
Jump to: navigation, search


function GetNextPacket: Integer; virtual;


virtual int __fastcall GetNextPacket();


Type Visibility Source Unit Parent
function public
Datasnap.DBClient TCustomClientDataSet


Retrieves the next block of records from the provider.

Call GetNextPacket to retrieve the next sequential block of records from a provider. To specify the maximum number of records to return in a packet, set the PacketRecords property before calling GetNextPacket. A packet is appended to those records already stored in the Data property.

GetNextPacket returns the number of records added to Data. If the return value is 0, the client dataset has already received all available records from the provider.

Warning: If the provider is in a stateless application server, you must use a BeforeGetRecords event handler to ensure that the data packet returns the correct set of records.

See Also

Code Examples