#include <RecordFileScan.h>
Public Member Functions | |
ReturnCode | openScan (RecordFileHandle *fileHandle, RecordFileScanCondition *condition) |
Initialize a record file scan. | |
ReturnCode | getNextRecord (Record *record) |
Get the next matching record. | |
ReturnCode | closeScan () |
Terminate the record file scan. |
This class provides clients the capability to perform scans over the records of a file, where a scan may be based on a specified condition. See method documentation below.
ReturnCode RecordFileScan::openScan | ( | RecordFileHandle * | fileHandle, | |
RecordFileScanCondition * | condition | |||
) |
Initialize a record file scan.
fileHandle | The handle to the record file to be scanned | |
condition | The selection condition for records to be returned |
Returns RC_OK on success, or a suitable error code on failure.
ReturnCode RecordFileScan::getNextRecord | ( | Record * | record | ) |
Get the next matching record.
record | The record will be copied here |
ReturnCode RecordFileScan::closeScan | ( | ) |
Terminate the record file scan.
Terminate the record file scan. Returns RC_OK on success, and other ReturnCode values otherwise.