BBjKeySegment

Creation

BBjAPI > BBjFileSystem > BBjKeySegment

 

Description

In BBj 6.0 and higher, BBjKeySegment objects are used to construct BBjKeyInfo objects. BBjKeyInfo objects can be used to manipulate VKEYED file key chains dynamically.

Creation

The BBjKeySegment object is created using the following BBjFileSystem method:

Return Value

Method

BBjKeySegment

makeKeySegment(int field, int offset, int length, boolean descending, boolean numeric)

Methods of BBjKeySegment

Return Value

Method

int

getField()

int

getOffset()

int

getLength()

boolean

isBUS()

boolean

isDescending()

boolean

isNumeric()

boolean

isOrderedNumeric()

Remarks

None.

Constants

0x00

INDEXED_FILE

0x01

SERIAL_FILE

0x02

DIRECT_FILE

0x03

STRING_FILE

0x04

BBX_PROGRAM_FILE

0x84

BBJ_PROGRAM_FILE

0x05

DIRECTORY_FILE

0x06

MKEYED_FILE

0x80

MKEYED_4GIG

0x40

MKEYED_RECOVERABLE

0x20

MKEYED_64BIT

0x08

XKEYED_FILE

0x0B

JKEYED_FILE (Deprecated)

0x0D

VKEYED_FILE

Example

rem ' Obtain the instance of the BBjFileSystem object

BBjFileSystem! = BBjAPI().getFileSystem()

rem ' Create a BBjKeySegment object
BBjKeySegment! = BBjFileSystem!.makeKeySegment(0,0,10,0,0)

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

See Also

BBjAPI

BBj Object Variables

BBj Object Assignment

BBj Object Error Handling

BBj Object Operators

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