mme_sync_cancel()

Cancels mediastore synchronization

Synopsis:

#include <mme/mme.h>

int mme_sync_cancel ( mme_hdl_t *hdl,
                      uint64_t msid );

Arguments:

hdl
An MME connection handle.
msid
The ID for the mediastore on which synchronization is to be stopped or cancelled.

Library:

mme

Description:

The function mme_sync_cancel() cancels mediastore synchronizations. Set the parameter msid to the mediastore ID of the mediastore for which you want to cancel synchronization.

If you set the parameter msid to 0, mme_sync_cancel() cancels all current and pending mediastore synchronizations on all devices.

All cancelled synchronizations send an MM_EVENT_SYNCABORTED event.

For an active synchronization the MME:

For pending synchronizations the MME

Events

This function can return synchronization error events (MME_SYNC_ERROR_*) and MME_EVENT_SYNCABORTED.

Blocking and validation

This function is non-blocking. It delivers a MME_EVENT_SYNCABORTED event for each completed cancellation. It does not validate the mediastore ID (msid).

Returns:

0
Success: the mediastore synchronization was cancelled, or the mediastore was not being synchronized when the cancellation request was made.
-1
An error occurred (errno is set).

Classification:

QNX Neutrino

Safety:
Interrupt handler No
Signal handler No
Thread Yes

See also:

mme_directed_sync_cancel(), mme_playlist_sync(), mme_resync_mediastore(), mme_setpriorityfolder(), mme_sync_directed(), mme_sync_file(), mme_sync_get_msid_status(), mme_sync_get_status()