BBjTriggerData::getModeValue

Description

In BBj 9.0 and higher, this method returns the value for the specified key defined in the MODE string when the file was opened.

Syntax

Return Value	Method
string	getModeValue(string p_modeKey)

Parameters

Variable	Description
p_modeKey	Key name for the value to retrieve from the MODE string.

Return Value

The value for the specified key from the MODE string. If the key does not have a value assigned, returns an empty string.

Remarks

None.

Example

rem 'Get the Trigger object from the BBj File System

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

rem 'Get the KeyName
userId$ = td!.getModeValue("UID")