SetDefinitions Method of the IFPCAlert Interface

[C++]

Syntax

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

Parameters

EventGUID

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

ServerName

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

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

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

[Visual Basic]

Syntax

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

Parameters

EventGUID

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

ServerName

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

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

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