FPCAlertNotification.Signal_N_Events Method

Used by ISA services to signal n instances of an event, as 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 event. Third-party application filters can also use this method to signal instances of an event.

VBScript Syntax[VBScript]

FPCAlertNotification.Signal_N_Events( sGuid, sServerName, lAdditionalKey, lEventsCount,
  sShortDesc, bstrLongDesc, lEventID, sEventSource, varEventStrings, 
  varEventData, shEventCategory, shEventType)

C++ Syntax[C++]

HRESULT Signal_N_Events(
  BSTR sGuid,
  BSTR sServerName,
  long lAdditionalKey,
  long lEventsCount,
  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. 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.

lEventsCount

Required. Counts the number of instances of the event.

sShortDesc

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

sLongDesc

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

lEventID

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

sEventSource

Required. String that contains source name for the event reported.

varEventStrings

Required. Variant that contains insertion strings for the event reported.

varEventData

Required. Variant that contains raw data for the event reported.

shEventCategory

Required. Short value that contains category of the event reported.

shEventType

Required. Short value 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.

Note  When you use the Signal_N_Events method, you must keep track of the time in which the n instances take place because the alert service assumes that the n instances all occurred at the last second. This differs from the SignalEvent, in which the alert service tracks the time.

Applies To

FPCAlertNotification