pulIMacro GetParameterHandle

Returns a handle to the specified parameter.

Syntax

pulIMacro GetParameterHandle param, index

Application

Tcl Query

Description

Returns a handle to the specified parameter.

Inputs

index: This command returns a handle to the parameter specified by index.
param: The handle can be accessed using the name specified by param.

Example

hwi GetSessionHandle sess
sess GetClientManagerHandle pm plot
pm GetMacroHandle macro 1
macro GetParameterHandle param_handle 1
puts [param_handle GetName]

Errors

Returns 3 if there is an invalid macro handle.

Returns 4 if index is less than 1 or greater than the number of parameters in the current macro.

Returns 1 if a handle to the specified parameter cannot be created.

Keywords

Macro

Tcl