HFSS15: Setting or Removing Option Values in Configuration Files: UpdateRegistry Command

A command line tool, UpdateRegistry, is available to modify option settings in the options config files. You can use this command to add, change or remove settings from any of the option config files. This tool is included in the installation directory of each product.

This feature is intended to make it easier for different users to use ANSYS Electromagnetics tools installed on shared directories or network drives.

The UpdateRegistry command has multiple command line formats as shown below. The first format is used to set or change an option value. The second format is used to delete an option setting.

UpdateRegistry -Get Command

This command is used to view an option value in an option config file. If the setting exists in the specified config file or files, then the value, the value type and the config file where the value was found will be reported. If no value is found, then that will also be reported.

Usage:

UpdateRegistry -Get -ProductName <name> -RegistryKey <keyPath> [ -RegistryLevel <level> ]

<name>

Required. The application or product name and version, as described above. Examples: HFSS15.0, Maxwell15.0, or "Maxwell Circuit Editor15.0". If the name contains spaces, it must be quoted.

<keyPath>

Required. The pathname of the option setting.

Example:

Desktop/Settings/ProjectOptions/AnimationMemory.

<level>

Optional. A string denoting which config file to search. One of: install, install_machine, user and user_machine. If the level is not specified, then all config files are searched in order of precedence.

UpdateRegistry -GetKeys Command

This command is used to view the allowed key names for all of the option settings, or to view a subset of the key names that match a string. For each key displayed, the current value, if any, is also reported. If a key has a value in multiple config files, then only the highest precedence value is reported.

Usage:

UpdateRegistry -GetKeys [ <pattern>] -ProductName <name> [ -Case ]

<pattern>

Optional. If no pattern is specified, then all allowed key names are reported. If a pattern is specified, then only keys that match the pattern are shown. Examples: Settings/Project. If the name contains spaces, then it must be quoted. By default, the pattern match is case insensitive. If the -Case command line option is specified, then the pattern match is case sensitive.

<name>

Required. The application or product name and version, as described above. Examples: HFSS14.0, Maxwell15.0, or "Maxwell Circuit Editor15.0". If the name contains spaces, it must be quoted.

UpdateRegistry -Set Command

This command is used to add or modify an option setting in an option config file. If the option config file does not exist, it will be created. If the setting does not exist in the specified config file, it will be added. If the setting already exists in the specified config file, then the value will be changed to the specified value.

Usage:

UpdateRegistry -Set -ProductName <name>
-RegistryKey <keyPath>
-RegistryValue <value> [ -RegistryLevel <level>
<name>

Required. The application or product name and version, as described above. Examples: HFSS14.0, Maxwell15.0, or "Maxwell Circuit Editor15.0". If the name contains spaces, it must be quoted.

<keyPath>

Required. The pathname of the option setting. Example:

Desktop/Settings/ProjectOptions/AnimationMemory.

<value>

Required. The new value of the option, typically a string or a number. If the value contains spaces, it must be quoted.

<level>

Optional. A string denoting which config file to modify. One of: install, install_machine, user and user_machine. If the level is not specified, then the user_machine (host dependent user options) file is modified.

UpdateRegistry -Delete Command

This command is used to remove an option setting from an option config file. If the setting does not exist in the specified config file, the file will not be changed. If the setting exists in the specified config file, then it will be removed. A setting may need to be removed from an option config file, to allow the setting from a lower priority file to be used by the application.

Usage:

UpdateRegistry -Delete -ProductName <name> _
-RegistryKey <keyPath> _
[ -RegistryLevel <level> ]

<name>

Required. The application or product name and version, as described above. Examples: HFSS14.0, Maxwell15.0, or "Maxwell Circuit Editor15.0". If the name contains spaces, it must be quoted.

<keyPath>

Required. The pathname of the option setting. Example:

Desktop/Settings/ProjectOptions/AnimationMemory.

<level>

Optional. A string denoting which option config file to modify. One of: install, install_machine, user and user_machine. If the level is not specified, then the user_machine (host dependent user options) file is modified.