handleEvent( )

Handles a PODSEvent object.

Interface

PODSEventHandler

IDL definition
PODSBoolean handleEvent(PODSEvent event);
JavaScript synopsis

Not applicable

C synopsis
PODSBoolean PODShandleEvent(
  PODSEventHandler* evhandler,
  PODSEvent* event
);
Parameters
  • evhandler   The PODSEventHandler 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.

PODSEventMgr ’s implementation of handleEvent() , inherited from PODSEventHandler , sends handleEvent() to each of the event handlers that have been registered. It returns PODS_TRUE if any event handler returns PODS_TRUE , indicating that one of the event handlers has handled the event and that no further processing of the event should occur. See PODSEventMgr object.

See also

PODSEventMgr object's handleEvent( )