BBjFileSystem::makeOrderedNumericKeySegment


Description

In BBj 10.0 and higher, this method creates an ordered numeric BBjKeySegment object. BBjKeySegment objects are used to construct BBjKeyInfo objects, which can be used to manipulate VKEYED file key chains dynamically.

Syntax

Return Value

Method

BBjKeySegment

makeOrderedNumericKeySegment(int field, int offset, int length, boolean descending)

Parameters

Variable

Description

field

Specifies the field number in the record, where fields are separated by the $0A$ character. Specify 0 to define a segment based on the entire record without regard to field separators.

offset

Specifies the zero-based offset within the field. Note this is different from the VKEYED verb, in which the one-based offset is specified.

length

Specifies the segment length.

descending

Indicates that the segment is in descending order.

Return Value

Returns a BBjKeySegment object. One or more BBjKeySegment objects are used to create a BBjKeyInfo object, which is used to manipulate VKEYED key chains.

Remarks

None.

Example

REM ' Obtain the instance of the BBjFileSystem object
BBjFileSystem!=BBjAPI().getFileSystem()

REM ' Create a BBjKeySegment object
BBjKeySegment!=BBjFileSystem!.makeOrderedNumericKeySegment(0,0,10,0)

REM ' Create a BBjKeyInfo object
BBjKeyInfo!=BBjFileSystem!.makeKeyInfo(BBjKeySegment!,0)

See Also

BBjAPI

BBjSysGui

Object Variables

See the BBj Object Diagram for an illustration of the relationship between BBj Objects