BBjAPI::setStbl

Description

In BBj 17.00 and higher, this method manipulates the global string table.

Syntax

Return Value

Method

string

setStbl(string key, string value)

Parameters

Variable

Description

key

A key or command as described in the STBL function.

value

The value for the specified key, or the key to be processed by the given command.

Return Value

In BBj 18.0 and higher, this method returns the new value of the specified key.

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)
>

See Also

BBjAPI

STBL() Function - Global String Table

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