TmEnumerateVars Function

Returns all the variables associated with an instance of a VDA Tool.

Usage

variables = TmEnumerateVars(tool_name)

Parameters

tool_name—A string containing the unique name of a VDA Tool.

Returned Value

variables—A 1D string array containing the names of the variables associated with the specified VDA Tool.

Discussion

This function is used frequently in VDA Tool programs to extract variable names that were passed to a VDA Tool for use in plotting, or data selection, or other kinds of routines that require variables. For example, in a graphics tool, TmEnumerateVars might be called by a plotting routine to find the names of variables that were passed to the VDA Tool program.

Example

The following code fragment shows how TmEnumerateVars can be used to get the names of variables from a VDA Tool, and then use UPVAR to bind the variable locally, in the WzTemplateConvert procedure.

PRO WzTemplateConvert, tool_name, user_data=user_data

   plot_var = TmEnumerateVars(tool_name)

   UPVAR, plot_var(0), local

   . . .

See Also

TmAddVar, TmDelvar, TmGetVarMainName