SPDRequestEvents

Purpose

Request information for all alert events from the Event Server. Outstanding events are reported individually through the normal event callback function, registered by SPDHandleEvent.

Syntax

#using Spo.SPDlib
SPD_errorType SPDRequestEvents
(
   SPD_eventType eventType
);

Description

This function is used to request all available information on outstanding events of the specified type from the Event Server. Outstanding events are reported individually through the normal event callback, registered through SPDHandleEvent.

eventType

identifies the type of event being requested. This function currently supports only events of type SPD_alarmEvent.

Return Value

The return value indicates whether an error occurred, as follows.

Return

Indication

SPD_normal

No error

SPD_invalidType

Bad eventType parameter

SPD_notInitialized

SPDInitClient not called previously

SPD_commFailure

Communications problem

SPD_errException

A .NET runtime exception occurs

See Also

See also the following client functions: