FPCAlert.AdditionalKey Property

Gets the index to the additional-key table of the event associated with this alert.

Additional keys serve as a means to subdivide event objects into related subevents; for example, to subdivide a disk-full event into log-disk-full or system-disk-full subevents. This allows for either different alerts that are specific to subevents or one alert that is specific to all subevents.

For example, an administrator can add separate alerts for each separate subevent by specifying an EventGUID and AdditionalKey property for each subevent. The AdditionalKey property is the index used in the additional-key table. Alternatively, an administrator can treat all subevents as a singular event by specifying EventGUID and setting AdditionalKey to zero. In other words, the index zero is reserved and shouldn't be overloaded with a user-specific additional key.

If an event has no subevents, then the value of this property should be -1.

The additional-key table cannot be modified; an administrator can only select keys from the table.

VBScript Syntax[VBScript]

[ lKey = ] FPCAlert.AdditionalKey

C++ Syntax[C++]

HRESULT get_AdditionalKey(
  long *plKey
);

Parameters

lKey

Long value that specifies the index.

The property is read-only.

Applies To

FPCAlert