Arbortext Command Language > Functions by Alphabetical Listing > get_custom_property
  
get_custom_property
get_custom_property (key[, default])
The get_custom_property function retrieves the value of a global parameter or variable that has been configured in an application.xml file.
The function returns the value for the name of the variable or other property specified by key. The return value is the Unicode string associated with the specified key (as defined in the application.xml file). 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 the application's unique full name is com.arbortext.sample and the preference name specified in application.xml is Color, then you would specify com.arbortext.sample.Color.
The optional default parameter specifies a value to substitute if the key parameter name is not specified in the application.xml file. If there is no matching parameter for the specified key as defined by application.xml, the default parameter value (if specified) will be returned instead.
Related Topics
get_custom_dir function
get_user_property function
application_name function