get_user_property
get_user_property (key[, default])
The get_user_property function returns the value for a property that has been set in one of the following ways:
• a value subsequently stored in the arbortext.wcf preferences file after being set initially by the set_user_property function.
The return value is the Unicode string associated with the user preference or other property specified by key. This value may be an empty string if no value is configured.
Specify key using the following format:
application.qualified.name.property-name
For example, if an application's fully qualified name is com.arbortext.sample and the user setting is windowVisible, then you would specify the key parameter as com.arbortext.sample.windowVisible.
The optional default parameter specifies the value to substitute if the key parameter name is not specified. If there is no matching parameter, the default parameter value (if any) will be returned if specified.
Related Topics