GetCustomEnum method

Returns the value stored in the MxValue as a qualified enum.

Class

IMxValue

Syntax

[C#]

void GetCustomEnum(

out string pValue,

out short pOrdinal,

out short pPrimitiveId,

out short pAttributeId

);

[Visual C++]

HRESULT GetCustomEnum(

[out] BSTR *pValue,

[out] short *pOrdinal,

[out] MxPrimitiveId *pPrimitiveId,

[out] MxAttributeId *pAttributeId

);

Parameters

pValue,

Receives the enumeration's string value.

pOrdinal,

Receives the enumeration's ordinal value.

pPrimitiveId,

Receives primitive ID of the primitive that contains the attribute holding an array of all the possible enumeration string values.

pAttributeId

Receives attribute ID of the attribute holding an array of all the possible enumeration string values.

Returns

S_OK - Success.

MX_E_ConversionNotSupported - The stored value is a type that cannot be converted to a qualified enum.

E_POINTER - An invalid pointer was passed in.