Microsoft Internet Security and Acceleration Server 2004 SDK |
The Signal method signals the event on the local server. If an alert exists for the event and the conditions for issuing the alert are met, actions may be taken to notify the administrator of the event. Third-party filters can also use this method to signal an event.
HRESULT Signal( long SignalCount, long AdditionalKey, BSTR ShortDesc, BSTR LongDesc, long EventID, BSTR EventSource, VARIANT EventStrings, VARIANT EventData, short EventCategory, short EventType );
The EventSource parameter is similar to the lpSourceName parameter of the Windows RegisterEventSource function. Other parameters for this function are similar to parameters in the Windows ReportEvent function, as shown in the following table. For more information, see the relevant function in MSDN.
Signal parameter | ReportEvent parameter |
---|---|
EventID | dwEventID |
EventStrings | lpStrings |
EventData | lpRawData |
EventCategory | wCategory |
EventType | wType |
Network data (including URLs and other data that comes from untrusted sources) should not be included in the EventStrings parameter for logging, because this can create a security risk. Such data, however, can be included in the RawData parameter for logging.
The Signal method signals the event on the local server. If an alert exists for the event and the conditions for issuing the alert are met, actions may be taken to notify the administrator of the event. Third-party filters can also use this method to signal an event.
Sub Signal( _ [ ByVal SignalCount As Long ], _ [ ByVal AdditionalKey As Long ], _ [ ByVal ShortDesc As String ], _ [ ByVal LongDesc As String ], _ [ ByVal EventID As Long ], _ [ ByVal EventSource As String ], _ [ ByVal EventStrings As Variant ], _ [ ByVal EventData As Variant ], _ [ ByVal EventCategory As Integer ], _ [ ByVal EventType As Integer ] _ )
This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.
The EventSource parameter is similar to the lpSourceName parameter of the Windows RegisterEventSource function. Other parameters for this function are similar to parameters in the Windows ReportEvent function, as shown in the following table. For more information, see the relevant function in MSDN.
Signal parameter | ReportEvent parameter |
---|---|
EventID | dwEventID |
EventStrings | lpStrings |
EventData | lpRawData |
EventCategory | wCategory |
EventType | wType |
Network data (including URLs and other data that comes from untrusted sources) should not be included in the EventStrings parameter for logging, because this can create a security risk. Such data, however, can be included in the RawData parameter for logging.
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.