FPCAlertNotification.SignalEvent Method

ISA services use this method to signal an event, as a part of the alert service. If an alert exists for the event and the event is in a state where it can trigger an alert, actions will be taken to notify the administrator of the event. Third-party filters can also use this method to signal an event.

VBScript Syntax[VBScript]

FPCAlertNotification.SignalEvent( sGuid, sServerName, lAdditionalKey,
  sShortDesc, sLongDesc, lEventID, sEventSource, varEventStrings, 
  varEventData, shEventCategory, shEventType)

C++ Syntax[C++]

HRESULT SignalEvent(
  BSTR sGuid,
  BSTR sServerName,
  long lAdditionalKey,
  BSTR sShortDesc,
  BSTR sLongDesc,
  long lEventID,
  BSTR sEventSource,
  VARIANT varEventStrings,
  VARIANT varEventData,
  short shEventCategory,
  short shEventType
);

Parameters

sGuid

Required. String that specifies the globally unique identifier (GUID) of the event triggering this alert.

sServerName

Required. String that specifies the name of the server triggering this alert. This should contain the value NULL or an empty string, specifying the local server.

lAdditionalKey

Required. Long value that contains the index to additional keys' table for this event. This parameter cannot be zero. If the signaled event has no additional-key table, the parameter should be -1.

sShortDesc

String that contains a brief description of the run-time event. Used as the subject line for a send-mail action.

sLongDesc

String that contains a detailed description of the run-time event. Used as the body text for a send-mail action.

lEventID

Long value that contains the identifier (ID) of the event to be reported to the system event log.

sEventSource

String that contains source name for the event reported.

varEventStrings

Variant that contains insertion strings for the event reported.

varEventData

Variant that contains raw data for the event reported.

shEventCategory

Short that contains category of the event reported.

shEventType

Short that contains type of the event reported.

Remarks

The parameter sEventSource is similar to the lpSourceName parameter of the Win32® RegisterEventSource function. Other parameters for this function are similar to parameters in the Win32 function ReportEvent, as shown in the following table. For more information, see the relevant function in MSDN.

Applies To

FPCAlertNotification