alGetEventData - gets data from certain events with non-scalar
void* alGetEventData(ALevent event)
event expects an ALevent structure initialized by alNextEvent(3dm) or
alGetEventData returns the event data information as a void pointer. This
call is used on certain non-scalar event parameters. Refer to
alParams(3dm) for a complete list of parameters that return event
information through alGetEventData(3dm).
After reading the event data, the void pointer should be cast to an event
information struct. Again, refer to alParams(3dm) for a complete list
event information structs.
The following code fragment shows how to retrieve data from events with
parameters of type AL_CONNECT.
* Get event from event queue
conn_info = (ALconnectionInfo *)alGetEventData(event);
Upon successful completion, alGetEventData(3dm) returns a void pointer.
Otherwise it returns NULL, and sets an error number. This error number
can be retrieved with oserror(3C).
alGetEventData can fail for the following reason:
AL_BAD_INVALID_EVENT event is invalid or null.
alNewEvent(3dm), alNextEvent(3dm), alCheckEvent(3dm), alParams(3dm),
alGetEventParam(3dm), alGetEventValue(3dm), alGetParams(3dm), oserror(3C)
PPPPaaaaggggeeee 2222 [ Back ]