IParameterDefinition Interface Reference

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

Properties
BSTR	Name [get]
	The name of the parameter.
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 built-in parameters equals to the parameter's GUID name.
• For STDL parameters format: group_name.param_name.

Use IParameterDefinition::Text to get description.

Returns

The name of the parameter.

ParameterType

ParameterType ParameterType

get

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