IFPCAlert::SetDefinitions method

Article
08/27/2012

Applies to: desktop apps only

The SetDefinitions method sets the following properties of the alert: the globally unique identifier (GUID) of the event for which the alert is issued, the name of the server that issues the alert, and the additional key. The three must be set simultaneously because they form a unique identifying triplet.

Syntax

HRESULT SetDefinitions(
  [in]            BSTR EventGUID,
  [in, optional]  BSTR ServerName,
  [in, optional]  long AdditionalKey
);

FPCAlert.SetDefinitions( _
  ByVal EventGUID As String, _
  [ ByVal ServerName As String ], _
  [ ByVal AdditionalKey As Long ] _
)

Parameters

EventGUID [in]
Required. String-formatted globally unique identifier (GUID) of the event for which the alert is issued.

ServerName [in, optional]

C++	BSTR that specifies the name of the server that is allowed to issue the alert. The default value is an empty string, which indicates that all servers are allowed to issue the alert.
VB	String value that specifies the name of the server that is allowed to issue the alert. The default value is an empty string, which indicates that all servers are allowed to issue the alert.

AdditionalKey [in, optional]
A 32-bit integer that specifies an additional key (index) in the table of subevents defined for the event for which the alert is issued. A value of 0 indicates all subevents. The default value is –1, which indicates that no additional key will be assigned to the alert.

Return value

C++

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

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

This method modifies the AdditionalKey, EventGUID, and ServerName properties of the alert.

The GUID supplied in the EventGUID parameter must be formatted as a string in the form {12345678-1234-1234-1234-123456789abc}. Note the presence of the braces normally used with GUIDs.

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