3.2.4.17 IValueMapItem

  • Article

The IValueMapItem interface is used to define a named-value pair.

The following properties MUST be implemented by the objects that implement the IValueMapItem interface.

The following is an XML representation of a ValueMapItem.

 <Key> </Key>
 <Description></Description>
 <Enabled></Enabled>
 <Value></Value> 
 

Property

Read/write

Description

Description

RW

Specifies the description of the item.

Enabled

RW

Specifies whether or not the item is enabled. If an item is not enabled, its Value property will be ignored. In typical usage, a ValueMap will contain a ValueMapItem for each of the multiple possible settings of the property that the ValueMap is passed to (such as an entry for every Keyword or every Level that can be used by an ITraceDataProvider). This Enabled property indicates whether or not the ValueMapItem will be used. Essentially, the ValueMap contains a ValueMapItem for each of the multiple possible options, and the Enabled property indicates which options are actually selected.

Key

RW

Specifies the name of the item. The name of the item can be any non-empty BSTR. The semantics of the key depend on the ValueMapType property, specified in section 3.2.4.18, of the IValueMap to which this IValueMapItem belongs. The over-the-wire transmission of a BSTR is specified in [MS-OAUT] section 2.2.23. The Performance Logs and Alerts Protocol does not have any predefined Key values or semantic definitions. The only condition Performance Logs and Alerts Protocol places on the Key is that it cannot be an empty BSTR.<36>

Value

RW

Specifies the value of the item. The value is stored in a VARIANT. The format and over the wire transmission of a VARIANT is specified in [MS-OAUT] section 2.2.29. Any VARIANT is a legal value for this property. The ValueMapItem is a generic container and the semantics of the Value property depend on what it is being used to contain. The ValueMapType property contains information regarding how the Value property will be interpreted. <37>

ValueMapType

RW

Specifies the type of ValueMap in which the ValueMapItem will be inserted. Information on the different types of ValueMaps are specified in section 2.2.2.11.

The following is an XML representation of a ValueMapItem; please see section 3.2.4.19 the XML layout of entire data collector set element.

  
 <Key> </Key>
 <Description></Description>
 <Enabled></Enabled>
 <Value></Value> 
 

Methods in RPC Opnum Order

Method

Description

Description (Get)

Retrieves the Description property.

Opnum: 7

Description (Put)

Sets the Description property.

Opnum: 8

Enabled (Get)

Retrieves the Enabled property.

Opnum: 9

Enabled (Put)

Sets the Enabled property.

Opnum: 10

Key (Get)

Retrieves the Key property.

Opnum: 11

Key (Put)

Sets the Key property.

Opnum: 12

Value (Get)

Retrieves the Value property.

Opnum: 13

Value (Put)

Sets the Value property.

Opnum: 14

ValueMapType (Get)

Retrieves the ValueMapType property.

Opnum: 15

ValueMapType (Put)

Sets the ValueMapType property.

Opnum: 16

Opnums 0, 1, and 2 are reserved for the IUnknown interface. Opnums 3, 4, 5, and 6 are reserved for the IDispatch interface.