IFPCEventDefinition::AdditionalKeys property

Applies to: desktop apps only

The AdditionalKeys property gets the table of additional keys and subevents defined for the event.

This property is read-only.

Syntax

HRESULT get_AdditionalKeys(
  VARIANT *pvKeys
);

' Data type: Variant

Property AdditionalKeys( _
  ByVal pvKeys As VARIANT _
) As Variant

Property value

Variant containing an array of strings that specify the subevents defined for the event. The index of each string is the additional key for the corresponding subevent. The additional key with an index equal to 0 is reserved to indicate all of the subevents defined for the event.

Error codes

This property method returns S_OK if the call is successful; otherwise, it returns an error code.

Remarks

This property is read-only.

Additional keys serve as a means to subdivide event objects into related subevents. For example, a service-started event can be subdivided into subevents for different Forefront TMG services. This provides for the issuance of either different alerts that are specific to subevents or a single alert that is specific to all subevents.

Note  The additional key with an index equal to 0 is reserved to indicate all of the subevents defined for the event.

Requirements

See also

FPCEventDefinition

Build date: 7/12/2010