company logo

PropertyHandle :: ReplaceOptions - Replace system variable

The function allows replacing system variable references in a text field. When the property handle refers to a text field that contains references to system variables (e.g. "...%SYSVAR1% ....") those references are be replaced by the text currently set for the referenced system variable (in an ini-file or by the application (-> SetSysVariable())).

When the function is called for persistent fields the updated text causes a modification and will be stored into the database. Hence, it might be better to create a copy of the property and replacing the text in the copy.

Return value:  Success ( logical  )

Implementation details

logical PropertyHandle  :: ReplaceOptions (  )