BBjTriggerData::getKeyDescriptions

Description

In BBj 9.00 and higher, this method returns the key description string describing the keys defined on the data file (if it is a multi-keyed MKEYED, XKEYED, or VKEYED file).

Syntax

Return Value	Method
byte[]	getKeyDescriptionss()

Parameters

None.

Return Value

A byte string describing all of the keys and segments defined on a multi-keyed MKEYED, XKEYED, or VKEYED file being accessed by the trigger.

Remarks

Methods that return byte[] can usually be treated as if they returned string, because BBj automatically handles the conversion. However, when that byte[] value is directly assigned to an object variable or passed to a Java method, BBj skips the conversion and the raw internal byte[] format is used. You can always use the STR() function to explicitly convert the byte[] value to a string.

Example

rem 'Get the Trigger object from the BBj File System

td! = BBjAPI().getFileSystem().getTriggerData()

rem 'Get the KeyName
descriptions$ = td!.getKeyDescriptions()