TipcEventDestroy

Name

TipcEventDestroy — destroy an event

Synopsis

T_BOOL TipcEventDestroy(event) 
T_IPC_EVENT event; 

Arguments

event — the event to destroy

Return Values

TRUE if the event was successfully destroyed, FALSE otherwise.

Diagnostics

If TipcEventDestroy fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcEventDestroy destroys the event.

Caution

When an event is created or destroyed from a thread other than the thread dispatching the events, a user event is added to the dispatcher to perform the actual creation or destruction. To ensure that event data, such as a socket or a connection, is not destroyed before the event is removed from the dispatcher, create a user event to destroy the event and to perform any necessary cleanup. See the example for TipcEventCreate.

See Also

TipcEventCreate

Examples

This example destroys an event:

if (!TipcEventDestroy(event)) { 
  return;  /* error */ 
}