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

Properties
SAFEARRAY	EnumerationItemTexts `[get]`
	The localized texts of the parameter enumeration items.

BSTR	GroupText `[get]`
	The localized text of the STDL parameter group.

BSTR	Name `[get]`
	The name of the parameter.

ParameterType	ParameterType `[get]`
	The type of the parameter.

GUID	ReferencedEntityType `[get]`
	The type of entity this parameter refers to.

BSTR	ReferencedEntityTypeS `[get]`
	Same as ReferencedEntityType, but returning GUID as a string.

BSTR	Text `[get]`
	The localized text that describes the meaning of the parameter.

Detailed Description

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

Property Documentation

◆ EnumerationItemTexts

SAFEARRAY EnumerationItemTexts

get

The localized texts of the parameter enumeration items.

Note: Returns null if the parameter type is different from ParameterType::ParameterType_AppDefinedEnum or ParameterType::ParameterType_UserDefinedEnum

Returns: Array of enumeration item texts.

◆ GroupText

BSTR GroupText

get

The localized text of the STDL parameter group.

Note: For built-in parameters equals to the empty string.

Returns: The text of the parameter group.

◆ 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.

◆ ReferencedEntityType

GUID ReferencedEntityType

get

The type of entity this parameter refers to.

Note: Returns an empty GUID if the parameter type is different from ParameterType::ParameterType_IntID.

Returns: The type of the referenced entity.

See also: Entity types

◆ Text

BSTR Text

get

The localized text that describes the meaning of the parameter.

Returns: The text of the parameter.

Properties