BBjAPI::getStbl

Description

In BBj 17.00 and higher, this method returns the value of a specified global string in the global string table.

Syntax

Return Value	Method
string	getStbl(string key)

Parameters

Variable	Description
key	A key or command as described in the STBL function.

Return Value

Returns the value of the specified key, or !ERROR=49 if the key doesn't have a value.

Remarks

This method is equivalent to the STBL function; it interacts with the same data structure.

Example

READY
>?stbl("!LOCALE")
en_US
>?bbjapi().getStbl("!LOCALE")
en_US
>bbjapi().setStbl("key","value")
>?bbjapi().getStbl("key")
value
>?stbl("key")
value
>bbjapi().setStbl("!CLEAR","key")
>?stbl("key")
!ERROR = 49  (Global string "key" is not defined)
>