TipcEventGetData

Name

TipcEventGetData — get a user event’s data

Synopsis

T_BOOL TipcEventGetData(event, data_return) 
T_IPC_EVENT event; 
T_PTR *data_return; 

Arguments

event — a user event

data_return — returned data

Return Values

TRUE if the data was successfully retrieved for the event, FALSE otherwise.

Diagnostics

If TipcEventGetData fails, it returns FALSE and sets the global SmartSockets error number to one of:

Description

TipcEventGetData gets the user-defined data for a user event.

Caution

None

See Also

TipcEventCreate

Examples

This example returns the user-defined data for a user event:

T_PTR data; 
 
if (!TipcEventGetData(event, &data)) { 
  return;  /* error */ 
}