TCustomBufDataset.getnextpacket function

Declaration

function getnextpacket: Integer

Function result

Number of record buffers processed in the data packet.

Description

GetNextPacket is an Integer function used to read the next available packet using the data packet reader for the dataset. A data packet can contain record buffers (up to the number specified in PacketRecords). The return value contains the number of record buffers read using the LoadBuffer method. The return value is 0 ( zero) if no packet records are available for the dataset.

GetNextPacket uses the default index for the dataset (DefaultBufferIndex) to include record buffers in the index for the dataset. Its AddRecord method is called to include the record buffer in the default index.

GetNextPacket is used in the implementation of the FetchAll, Locate, GetRecord and GetDatasetPacket methods, and when setting the value in the RecNo property.

See also

• TCustomBufDataset.PacketRecords
• TCustomBufDataset.GetDatasetPacket
• TCustomBufDataset.Locate
• TDataset.RecNo