AddWithStorageName Method of the IFPCAlerts Interface

The AddWithStorageName method creates a new FPCAlert object with a specified storage name in the collection and returns a reference to it.

[C++]

Syntax

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

Parameters

Name
Required. BSTR 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
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.
StorageName
BSTR that specifies the storage name for uniquely identifying the new alert. The default value is an empty string.
AdditionalKey

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

Address of an interface pointer that on return points to the new IFPCAlert interface created.

Return Value

This method can return one of the following:

[Visual Basic]

Syntax

Function AddWithStorageName( _
  ByVal Name As String, _
  ByVal EventGUID As String, _
  [ ByVal ServerName As String ], _
  [ ByVal StorageName As String ], _
  [ ByVal AdditionalKey As Long ] _
) As FPCAlert

Parameters

Name
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
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.
StorageName
String value that specifies the storage name for uniquely identifying the new alert. The default value is an empty string.
AdditionalKey

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.

Return Value

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.

The storage name supplied in the StorageName parameter specifies the name that will be used to identify the alert whenever its properties are written to permanent storage or a file. The storage name is used to compare the identity of objects during import and export operations. The AddWithStorageName method should be used in code that adds an alert during registration of a filter, or in any other third-party add-in that adds an alert when it is initialized.

After an alert object has been created, its storage name can be retrieved using the PersistentName property.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCAlerts


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.

[an error occurred while processing this directive]