mme_directed_sync_cancel()

Cancels a specified directed synchronization

Synopsis:

#include <mme/mme.h>

int mme_directed_sync_cancel( mme_hdl_t *hdl,
                              int operation_id );


Arguments:

hdl
An MME connection handle.
operation_id
The operation ID of the directed synchronization to be cancelled.

Library:

mme

Description:

The function mme_directed_sync_cancel() cancels a specified directed synchronization. The synchronization to cancel can be either in progress or pending.

To cancel a directed synchronization, set the parameter operation_id to the synchronization ID returned by mme_sync_directed().

For more information about directed synchronizations, see mme_sync_directed().

Events

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

Blocking and validation

This function validates operation_id before returning.

Returns:

0
Success: the directed 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_resync_mediastore(), mme_setpriorityfolder(), mme_sync_directed(), mme_sync_file(), mme_sync_get_msid_status(), mme_sync_get_status()