hwIReportTemplate GetParameterInfo
Returns information about the parameter input.
Syntax
hwIReportTemplate_handle GetParameterInfo param_idx
Application
HyperWorks Tcl Query
Description
This command returns a list of information about the input parameter (within {}). The name for the parameter is first on the list, followed by the parameter title in the GUI (within another set of {}). Next in the list is the value of the the parameter input in the GUI (also within {}). Following that is the type in the parameter input (either file or value). If the type of input is a file, the last item on the list will be the type of file. An example of a returned list is: {dat_file {Wheel datafile name} {C:/demos/mv_hv_hg/reports/text_summary/sdf.dat} file *.dat}
Inputs
- param_idx
- The index (position) of the parameter that you want to get information for (within the list of all parameters in the report).
Example
hwi GetSessionHandle sess;
sess GetReportTemplateHandle rep 1;
rep GetParameterInfo 1;
Error
Success (the list) or an error message is returned.
Keywords
HyperWorks
Tcl
Report Template
Template
Query