IFPCAlerts::Add method

Article
08/27/2012

Applies to: desktop apps only

The Add method creates a new FPCAlert object in the collection and returns a reference to it.

Syntax

HRESULT Add(
  [in]            BSTR Name,
  BSTR EventGUID,
  [in, optional]  BSTR ServerName,
  [in, optional]  long AdditionalKey,
  [out]           IFPCAlert **ppNewAlert
);

FPCAlerts.Add( _
  ByVal Name As String, _
  ByVal EventGUID As String, _
  [ ByVal ServerName As String ], _
  [ ByVal AdditionalKey As Long ], _
  ByRef ppNewAlert As IFPCAlert _
) As FPCAlert

Parameters

Name [in]

C++	Required. BSTR that specifies the name of the alert. This name can be used in the Item method to retrieve the alert object.
VB	Required. String value that specifies the name of the alert. This name can be used in the Item method to retrieve the alert object.

EventGUID
Required. String-formatted globally unique identifier (GUID) of the event for which the new alert will be issued.

ServerName [in, optional]

C++	BSTR that specifies the name of the server that will be allowed to issue the new alert. The default value is an empty string. If no server is specified, any server will be allowed to issue the alert.
VB	String value that specifies the name of the server that will be allowed to issue the new alert. The default value is an empty string. If no server is specified, any server will be 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 new alert will be issued. The value set should be less than or equal to the number of subevents defined for the event. A value of 0 indicates all subevents. The default value is –1, which indicates that no additional key will be assigned to the alert.
ppNewAlert [out]
Address of an interface pointer that on return points to the new IFPCAlert interface created.

Return value

C++

This method can return one of the following:

S_OK, indicating that the operation succeeded.
An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

This method returns a reference to an FPCAlert object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

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