AIDA_boDeleteEvent

The AIDA_boDeleteEvent function frees all memory used by an AIDA event.

bool AIDA_boDeleteEvent(
  AIDA_tstEvent *pstEvent
);

Parameters

pstEvent

A pointer to an event either created by the application or by the AIDA system.

Return Values

AIDA_boDeleteEvent returns True in case of success.

If the event could not be deleted the function returns False. The application can retrieve the error code using AIDA_iGetError.

Remarks

In case of an error the event may not be used for any further activities since it is not clear which parts of the event structure already have been freed.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Linux: Requires a kernel supporting ELF binaries.
  Header: Declared in bsk_aida.h, also requires portab.h.
  Import Library (Windows): Use BSK_AIDA.lib.

See Also

AIDA Overview, AIDA Functions, AIDA_pstCreateEvent, AIDA_pstCreateEventEx, AIDA_boSetEventID, AIDA_pstCloneEvent, AIDA_boSendEvent, AIDA_pstReceiveEvent, AIDA_boWaitEvent, AIDA_boSetEventTypes, AIDA_boGetEventTypes