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

Public Member Functions
HRESULT	GetEnumerationItemText ([in] int enumValue, [out, retval] BSTR *pText)
	Localized text for the specified enumeration value.

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.

Member Function Documentation

◆ GetEnumerationItemText()

HRESULT GetEnumerationItemText	(	[in] int	enumValue,
		[out, retval] BSTR *	pText )

Localized text for the specified enumeration value.

Note: Returns null if the parameter type is different from ParameterType_AppDefinedEnum or ParameterType_UserDefinedEnum.; Returns null if the specified value is outside the valid range for the enumeration.

Parameters

[in]	enumValue	The enumeration value obtained via IParameter::GetIntValue.
[out]	pText	Enumeration item text.

Returns: Enumeration item text.

See also: EnumerationItemTexts

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_AppDefinedEnum or ParameterType_UserDefinedEnum

Returns: Array of enumeration item texts.

See also: GetEnumerationItemText

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

Public Member Functions

Properties