BBjAPI::getClientProperty

Description

In BBj 7.00 and higher, this method returns a java.lang.Object that is currently stored in the interpreter's client properties.

Syntax

Return Value	Method
java.lang.Object	getClientProperty(string propertyName)

Parameters

Variable	Description
propertyName	The name of the property.

Return Value

Returns a java.lang.Object or NULL if the property does not exist.

Remarks

Property names are case sensitive. If the property specified does not have a value set in this interpreter instance, it returns NULL. This is most commonly used for passing information from one type of trigger to another. For example, use setClientProperty and getClientProperty to set a property in the before write trigger and later retrieve that value during the after write trigger.

Example

rem 'Set a property in the interpreter.

BBjAPI.setClientProperty("myApp.myProperty", "The Value")

rem 'Now retrieve the value
myObj! = BBjAPI.getClientProperty("myApp.myProperty")