file.positionTo()

This method positions the file at the next record with a key or relative record number equal to or greater than that specified in the search argument.

Parameters

Search argument - A Number, String, or Array value specifying a relative record number, key value, or list of key values (array of Number/String). The special values pjs.HIGH_VALUE, pjs.LOW_VALUE, pjs.START, and pjs.END can also be used.
Record format name (optional/omissible) - A String value specifying the record format name.
Lock (optional/omissible) - Pass true to lock the positioned record. Otherwise, the record will not be locked.

The Lock parameter was added in version 7.24.0.
File must be opened for update for locking to occur.
Record locking is not implemented in RLA → SQL mode.

Exception Handling

An Error instance will be thrown with the following properties:

message - The message text.
error - The message id.
help - The message help text.

Examples

Position to end of file to read last record

pjs.defineTable("myfile", { keyed: true, read: true });
myfile.positionTo(pjs.END);
myfile.fetchPrevious();

Read all records with first and second keys equal to 100 and 200

pjs.defineTable("myfile", { keyed: true, read: true });
myfile.positionTo([100, 200]);
myfile.fetchNextEqual([100, 200]);
while (!file.endOfData()) { 
  // Do something with record data here.
  myfile.fetchNextEqual([100, 200]);
}

RPG Equivalent

SETLL

Requirements

This API requires the Profound.js Connector module.