libimobiledevice  1.3.0
API Documentation - Return to Homepage

◆ mobilebackup2_receive_message()

mobilebackup2_error_t mobilebackup2_receive_message ( mobilebackup2_client_t  client,
plist_t *  msg_plist,
char **  dlmessage 
)

Receives a DL* message plist from the device.

This function is a wrapper around device_link_service_receive_message.

Parameters
clientThe connected MobileBackup client to use.
msg_plistPointer to a plist that will be set to the contents of the message plist upon successful return.
dlmessageA pointer that will be set to a newly allocated char* containing the DL* string from the given plist. It is up to the caller to free the allocated memory. If this parameter is NULL it will be ignored.
Returns
MOBILEBACKUP2_E_SUCCESS if a DL* message was received, MOBILEBACKUP2_E_INVALID_ARG if client or message is invalid, MOBILEBACKUP2_E_PLIST_ERROR if the received plist is invalid or is not a DL* message plist, or MOBILEBACKUP2_E_MUX_ERROR if receiving from the device failed.