mm_sync_events_get()

Get the next queued mmsync 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

mmsync_event

A pointer to the event

Library:

mmsyncclient

Description:

Get the next queued mm-sync event. The event returned is stored in the mmsync_hdl_t object passed into the function. The client must not delete this event by passing it to free(). When mm_sync_events_get() is called on an mmsync_hdl_t object, it invalidates the previous mmsync_event_t returned. Clients that want to keep the old event should copy it before calling mm_sync_events_get() a second time.

Returns:

0 on success, -1 on failure