mm_sync_events_get()

Get the next queued mm-sync event

Synopsis:

#include <mmsync/mmsyncclient.h>
int mm_sync_events_get(mmsync_hdl_t *hdl,
                       mmsync_event_t **mmsync_event)

Arguments:

hdl
The mm-sync connection handle pointer.
mmsync_event
A pointer to the location for storing the address of the event information structure, which is filled in by this function.

Library:

mmsyncclient

Description:

Get the next queued mm-sync event. When you call this function, mm-sync copies the event information from the handle (in hdl) into an mmsync_event_t structure and stores the address of this structure at the location pointed to by mmsync_event.

Each call to this function invalidates the previous event information. So if you want to keep the data for an event, you must make a copy of the mmsync_event_t structure referenced by mmsync_event before calling this function again to get the next event. Also, you must not delete the event structure using free(); the mm-sync library manages this memory.

Returns:

0 on success, -1 on failure.