Arbortext Command Language > Functions by Alphabetical Listing > read_preferences
  
read_preferences
read_preferences (path[, doc])
This function reads the preferences stored in the preferences file specified by path, and uses them to update the current local scope (window, document, and view) values, updating the current window display. Note that the path to the preferences file cannot contain just single backslashes ("\"). The path must contain single forward slashes ("/"), double backslashes ("\\"), or single backslashes with the entire path enclosed in single quotes.
If the function executes successfully, it returns a one (1). If the path is invalid, the function returns a zero (0).
* 
The doc parameter is not currently used and may be removed in a future release.
Example:
read_preferences("C:/temp/arbortext.wcf")
read_preferences("C:\\temp\\arbortext.wcf")
Related Topics
Set option scope
option_scope function
set command