BBjTriggerData::getKey

Description

In BBj 6.00 and higher, this method returns the Key option's value.

Syntax

Return Value

Method

byte[]

getKey()

Parameters

None.

Return Value

The Key= Option from the Read/Extract Verb.

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 Key
key$ = td!.getKey()

See Also

BBjAPI

BBjTriggerData

ObjectVariables

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