Microsoft Internet Security and Acceleration Server 2004 SDK

AdditionalKeys Property of IFPCEventDefinition[C++]

FPCEventDefinition.AdditionalKeys [Visual Basic]

[C++]

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

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 Values

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 ISA Server 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.

[Visual Basic]

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

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 ISA Server 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

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCEventDefinition