IFPCAlert::AdditionalKey property

Article
08/27/2012

Applies to: desktop apps only

The AdditionalKey property gets the additional key (index) in the table of subevents defined for the event for which the alert is issued.

This property is read-only.

Syntax

HRESULT get_AdditionalKey(
  long *plKey
);

' Data type: Long

Property AdditionalKey( _
  ByVal plKey As long _
) As Long

Property value

A 32-bit integer that specifies the additional key.

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. Its value can be modified, along with the values of the EventGUID and ServerName properties, by calling the SetDefinitions method. Its default value is –1.

Additional keys serve as a means to subdivide event objects into related subevents. For example, a disk-full event can be subdivided into log-disk-full and system-disk-full subevents. This provides for the issuing of either different alerts that are specific to subevents or a single alert that is specific to all subevents.

For example, an administrator can add separate alerts for each separate subevent by specifying the applicable values of the EventGUID and AdditionalKey properties for each subevent. The AdditionalKey property is the index used in the table of subevents. Alternatively, an administrator can treat all subevents as a single event by specifying the EventGUID and setting the AdditionalKey to 0. In other words, the index 0 is reserved and should not be overloaded with a user-specified subevent.

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

The table of subevents cannot be modified; an administrator can only select keys from the table.

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll