AdditionalKeys Property of the IFPCEventDefinition Interface

Article
08/13/2010

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

C++

HRESULT get_AdditionalKeys(
    VARIANT* pvKeys
);

Parameters

pvKeys
Pointer to a VARIANT that is set on return to a VARIANT containing an array of strings that specify the subevents defined for the event. The index of each string is a 32-bit integer that specifies 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.

Return Value

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

Visual Basic

Property AdditionalKeys 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.

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

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via