hwIPreferenceManager GetPreferenceFileComponentList

Syntax

hwIPreferenceManager_handle GetPreferenceFileComponentList prefIndex, menuName, filePath

Application

HyperWorks Tcl

Description

This command returns a list containing component information for the input preference file. This command returns the menu name, file path, two true/false values and components that use the file in a list. The first true/false value determines if the file is the default preference file (true if it is; false if it is not). The second true/false value determines if the file is currently loaded (true if it is; false if it is not). 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 0; the second would have a 1 and so on. If you don't know or want to supply the index, a -1 must be input.

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 does 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 GetPreferenceFileComponentList 3 MyFile.mvw c:/MyFile.mvw;

Error

Success (the default preference component list) or an error message is returned.

Keywords

HyperWorks

Tcl

Preference Manager