Microsoft Internet Security and Acceleration Server 2004 SDK

IFPCAlert::SetDefinitions[C++]

FPCAlert.SetDefinitions [Visual Basic]

[C++]

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.

HRESULT SetDefinitions(
  BSTR EventGUID,
  BSTR ServerName,
  long AdditionalKey
);

Parameters

EventGUID
[in] Required. String-formatted globally unique identifier (GUID) of the event for which the alert is issued.
ServerName
[in, optional] 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.
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 Values

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

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.

[Visual Basic]

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.

Sub 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] 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 Values

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

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCAlert