v2.35
 
IParameterDefinition Interface Reference

Represents a parameter definition. This interface can be obtained through IParameter. More...

Inheritance diagram for IParameterDefinition:

Properties

BSTR Name [get]
 The name of the parameter. For STDL parameters format: group_name.param_name. Empty for buildin parameters, use IParameterDefinition::Text to get description.
 
ParameterType ParameterType [get]
 The type of the parameter.
 
BSTR Text [get]
 The localized text that describes the meaning of the parameter.
 
SAFEARRAY UserDefinedEnumerationItems [get]
 User defined enumeration items.
 

Detailed Description

Represents a parameter definition. This interface can be obtained through IParameter.

Property Documentation

◆ Name

BSTR Name
get

The name of the parameter. For STDL parameters format: group_name.param_name. Empty for buildin parameters, use IParameterDefinition::Text to get description.

Returns
The name of the parameter.

◆ ParameterType

The type of the parameter.

Returns
The type of the parameter.

◆ Text

BSTR Text
get

The localized text that describes the meaning of the parameter.

Returns
The text of the parameter.

◆ UserDefinedEnumerationItems

SAFEARRAY UserDefinedEnumerationItems
get

User defined enumeration items.

Returns
User defined enumeration items if parameter user defined, else returns null