Product Documentation

c-treeDB API for C# - Developers Guide

Previous Topic

Next Topic

CTRecord.NextInBatch

Retrieves the next batch of records from batch retrieval operation.

Declaration

bool CTRecord.NextInBatch();

Description

If the mode of the batch operation is one of CTBATCH_GET, CTBATCH_RANGE or CTBATCH_PHYS then it may be necessary to retrieve all records that match the batch criteria. The records are retrieved by calling NextInBatch() method. NextInBatch() method retrieve the record data from the batch buffer maintained by c-treeDB's record handle. After a successful call to NextInBatch() function the field data can be retrieved by calling the appropriate GetFieldAs...() methods.

Return

YES if successful, NO if no more record match the criteria.

Throws a CTException on error.

NextInBatch() does not throw an exception when the end of the batch is reached.

See Also

CTRecord.BatchLocked(), CTRecord.BatchMode(), CTRecord.EndBatch(), CTRecord.InsertBatch(), CTRecord.IsBatchActive(), CTRecord.NextBatch(), CTRecord.SetBatch(), CTRecord.BatchLoaded

TOCIndex