handleEvent( )

Handle a PODSEvent object.

Interface

PODSEventMgr

IDL definition

PODSBoolean handleEvent(PODSEvent event);

JavaScript synopsis

Not applicable

C synopsis

PODSBoolean PODShandleEvent(
  PODSEventMgr* evmgr,
  PODSEvent* event
);

Parameters

evmgr The PODSEventMgr object.
event [in] The PODSEvent object to handle.

Returns

PODS_TRUE

If the PODSEvent object was successfully handled.

PODS_FALSE

Otherwise.

Remarks

Event handlers should return PODS_TRUE to indicate the event handler has been handled and does not need any further processing.

The PODSEventMgr implementation of handleEvent( ), inherited from PODSEventHandler, sends handleEvent( ) to each of the event handlers that have been registered. It returns PODS_TRUE as soon as an event handler returns PODS_TRUE, indicating that the event was handled and that no further processing of the event should occur. The PODSEventHandler implementation only checks the specified event handler.