PutCustomEnum method

Stores an MxCustomEnum in the MxValue. The MxValue's data type will be MxCustomEnum.

Class

IMxValue

Syntax

[C#]

void PutCustomEnum(

string value,

short ordinal,

short primitiveId,

short attributeId

);

[Visual C++]

HRESULT PutCustomEnum(

[in] LPCWSTR value,

[in] short ordinal,

[in] MxPrimitiveId primitiveId,

[in] MxAttributeId attributeId

);

Parameters

value,

The enumeration's string value. This parameter is used by Message Exchange clients. BRO can pass in 0 for internal clients.

ordinal,

The enumeration's ordinal value. This parameter is used by primitives. Other clients can pass in 0.

primitiveId,

The primitive corresponding to the attribute which holds an array of all the possible enumeration string values, or just pass in 0. This parameter is ignored by the BRO on external sets. This parameter is used by the BRO to initialize an MxValue.

attributeId

The attribute holding an array of all the possible enumeration string values, or just pass in 0. This parameter is ignored by the BRO on external sets. This parameter is used by the BRO to initialize an MxValue.

Returns

S_OK - Success