hwIPreferenceManager GetPreferenceFileMenuComponentList

Syntax

hwIPreferenceManager_handle GetPreferenceFileMenuComponentList

Application

HyperWorks Tcl

Description

This command returns component information for the input preference file. This command returns the components that use the file. A component is one of the six available clients: framework, post, fepre, hwplot, plot3d, video, and texteditor.

Inputs

prefIndex

The index (position within the internal list of preference files) of the preference file that you want to use within the list of preference files. This index is a zero-based index, meaning the positions start at zero, rather than one. Therefore, the first preference file in the list would have an index of zero; the second would have a one and so on. If you do not know or does not want to supply the index, a -1 must be inputted.

menuName

The menu name of the file that you want to get the component list for. A null string, “”, can also be input if you do not know or do not want to input the menu name. If the menu name is supplied, it is used to search for a preference file match.

filePath

The filepath of the desired file (within “” or {} if there are spaces in the filepath) that you want to get the component list for. A null string, “”, can also be input if you do not know the filepath or do not want to input the filepath. If the filepath is supplied, it is used to search for a preference file match.

Example

hwi GetSessionHandle sess;
sess GetPreferenceManagerHandle pref;
pref GetPreferenceFileMenuComponentList 3 “” “”;

Error

Success (the components) or an error message is returned.

Keywords

HyperWorks

Tcl

Preference Manager