libimobiledevice  1.3.0
API Documentation - Return to Homepage

◆ mobilesync_start()

mobilesync_error_t mobilesync_start ( mobilesync_client_t  client,
const char *  data_class,
mobilesync_anchors_t  anchors,
uint64_t  computer_data_class_version,
mobilesync_sync_type_t sync_type,
uint64_t *  device_data_class_version,
char **  error_description 
)

Requests starting synchronization of a data class with the device.

Parameters
clientThe mobilesync client
data_classThe data class identifier to sync
anchorsThe anchors required to exchange with the device. The anchors allow the device to tell if the synchronization information on the computer and device are consistent to determine what sync type is required.
computer_data_class_versionThe version of the data class storage on the computer
sync_typeA pointer to store the sync type reported by the device_anchor
device_data_class_versionThe version of the data class storage on the device
error_descriptionA pointer to store an error message if reported by the device
Return values
MOBILESYNC_E_SUCCESSon success
MOBILESYNC_E_INVALID_ARGif one of the parameters is invalid
MOBILESYNC_E_PLIST_ERRORif the received plist is not of valid form
MOBILESYNC_E_SYNC_REFUSEDif the device refused to sync
MOBILESYNC_E_CANCELLEDif the device explicitly cancelled the sync request