vlNextEvent(3dm)vlNextEvent(3dm)NAME
vlNextEvent, vlCheckEvent, vlPeekEvent, vlEventToName, vlPending - VL
event handling routines
SYNOPSIS
#include <dmedia/vl.h>
int vlNextEvent(VLServer svr, VLEvent *event);
int vlPeekEvent(VLServer svr, VLEvent *event);
int vlCheckEvent(VLServer svr, VLEventMask mask, VLEvent *event);
char *vlEventToName(uint type);
int vlPending(VLServer svr);
PARAMETERS
svr Specifies the server.
event Pointer to structure to return data in.
mask bitmask of events to check for.
type type of event.
DESCRIPTION
vlNextEvent returns the next event in the video event queue removing it
from the queue, and blocks until an event is available.
vlPeekEvent returns the next event in the video event queue without
removing it from the queue, and blocks if an event is not available.
vlCheckEvent looks for the next event in the video event queue matching
the specified event mask. If it finds a matching event, that event is
removed from the queue and returned to the caller. If no event is found,
the call returns immediately with the value of -1.
vlEventToName takes an event and maps it to a character string for later
use.
vlPending returns the number of events pending on the queue.
RETURN VALUE
If successful, vlNextEvent, vlCheckEvent, and vlPeekEvent return zero. A
value of -1 indicates an error.
SEE ALSOvlSelectEvents(3dm), vlcallbacks(3dm), vlConnectionNumber(3dm)
Page 1
