The IDLitParameter::GetParameterAttribute procedure method retrieves one or more parameter attributes for a registered parameter.
Obj->IDLitParameter::GetParameterAttribute(ParamName [, KEYWORD=variable] )
A scalar string or string array containing names of registered parameters.
Any keyword listed under IDLitParameter::RegisterParameter can be retrieved using this method. To retrieve the value of an attribute, specify the attribute name as a keyword set equal to a named variable that will contain the value of the attribute.
This example creates an iPlot tool and retrieves the description attribute of the registered parameter named "vertices":
IPLOT, RANDOMU(seed, 15)
idTool = ITGETCURRENT(TOOL=otool)
idPlot = oTool->FindIdentifiers('*plot*', /VISUALIZATIONS)
oPlot = oTool->GetByIdentifier(idPlot)
oPlot->GetParameterAttribute, 'vertices', DESCRIPTION=desc
PRINT, desc
IDL prints:
Vertex Data
Introduced: 6.1
IDLitParameter::QueryParameter, IDLitParameter::RegisterParameter, IDLitParameter::SetParameterAttribute