← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libimobiledevice/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/html/include_2libimobiledevice_2mobilebackup2_8h.html

  • Committer: Package Import Robot
  • Author(s): Chow Loong Jin
  • Date: 2013-10-28 23:01:08 UTC
  • mfrom: (1.1.9) (6.1.8 experimental)
  • Revision ID: package-import@ubuntu.com-20131028230108-5175bco54jhkv693
Tags: 1.1.5-1
http://bugs.debian.org/709369
http://bugs.debian.org/682275
* Team upload.
* Ack NMU from Andreas Metzler
* [1282e33] Imported Upstream version 1.1.5 (Closes: #709369):
  - Adapt to libusbmuxd API changes (Closes: #682275)
* [27231df] Refresh or drop patches
  - 00git_ios5_support.patch: Drop, applied upstream
  - 01-libs.private.patch: Refresh
  - 02-add-missing-linking.patch: Drop, applied upstream
  - 03_ac_pkg_swig_m4_fixed.patch: Drop, no longer relevant
  - 04_libplist_DSO_linking.patch: Drop, applied upstream
  - 05_remove_gcry_need.patch: Drop, no longer relevant
* [0f497a0] Drop --host and --build arguments from configure.
  This is already applied by dh_auto_configure automatically.
* [a370ab0] Reindent build-depends and drop trailing whitespace
* [a3fffe5] Bump dh compat to 9 for buildflags
* [40725ee] Enable multi-arch
* [65d74c4] Move dh --with parameter after $@
* [596a2b7] Update command for removing *.la for multiarch path
* [979998b] Update .manpages file for new utilities
* [3c37d78] Don't ship embedded jquery.js

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/include_2libimobiledevice_2mobilebackup2_8h.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
5
6
<title>libimobiledevice: libimobiledevice/mobilebackup2.h File Reference</title>
6
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
<script type="text/javascript" src="jquery.js"></script>
 
9
<script type="text/javascript" src="dynsections.js"></script>
 
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
8
11
</head>
9
12
<body>
10
 
<!-- Generated by Doxygen 1.7.3 -->
11
 
<div id="top">
 
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
12
14
<div id="titlearea">
13
15
<table cellspacing="0" cellpadding="0">
14
16
 <tbody>
15
17
 <tr style="height: 56px;">
16
18
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">libimobiledevice&#160;<span id="projectnumber">1.1.1</span></div>
 
19
   <div id="projectname">libimobiledevice
 
20
   &#160;<span id="projectnumber">1.1.5</span>
 
21
   </div>
18
22
  </td>
19
23
 </tr>
20
24
 </tbody>
21
25
</table>
22
26
</div>
 
27
<!-- end header part -->
 
28
<!-- Generated by Doxygen 1.8.1 -->
23
29
  <div id="navrow1" class="tabs">
24
30
    <ul class="tablist">
25
31
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33
39
      <li><a href="globals.html"><span>Globals</span></a></li>
34
40
    </ul>
35
41
  </div>
 
42
<div id="nav-path" class="navpath">
 
43
  <ul>
 
44
<li class="navelem"><a class="el" href="dir_0839347dbfd1d6806a2d090799a179ba.html">libimobiledevice</a></li>  </ul>
36
45
</div>
 
46
</div><!-- top -->
37
47
<div class="header">
38
48
  <div class="summary">
39
49
<a href="#typedef-members">Typedefs</a> &#124;
40
50
<a href="#func-members">Functions</a>  </div>
41
51
  <div class="headertitle">
42
 
<h1>libimobiledevice/mobilebackup2.h File Reference</h1>  </div>
43
 
</div>
 
52
<div class="title">mobilebackup2.h File Reference</div>  </div>
 
53
</div><!--header-->
44
54
<div class="contents">
45
55
 
46
56
<p>Backup and restore of all device data (mobilebackup2, iOS4+ only)  
47
 
<a href="#_details">More...</a></p>
 
57
<a href="#details">More...</a></p>
48
58
<table class="memberdecls">
49
 
<tr><td colspan="2"><h2><a name="typedef-members"></a>
 
59
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
50
60
Typedefs</h2></td></tr>
51
 
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a></td></tr>
52
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an error code.  <a href="#aeae49da50c4638bd5a3178e9a4b00a2e"></a><br/></td></tr>
53
 
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
 
61
<tr class="memitem:aeae49da50c4638bd5a3178e9a4b00a2e"><td class="memItemLeft" align="right" valign="top">typedef int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a></td></tr>
 
62
<tr class="memdesc:aeae49da50c4638bd5a3178e9a4b00a2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an error code.  <a href="#aeae49da50c4638bd5a3178e9a4b00a2e"></a><br/></td></tr>
 
63
<tr class="memitem:a0cf69d4c02a02f37f1f864946aa4670a"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
54
64
<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_private</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a></td></tr>
55
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle.  <a href="#a0cf69d4c02a02f37f1f864946aa4670a"></a><br/></td></tr>
56
 
<tr><td colspan="2"><h2><a name="func-members"></a>
 
65
<tr class="memdesc:a0cf69d4c02a02f37f1f864946aa4670a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle.  <a href="#a0cf69d4c02a02f37f1f864946aa4670a"></a><br/></td></tr>
 
66
</table><table class="memberdecls">
 
67
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
57
68
Functions</h2></td></tr>
58
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#acafbe3a637937faead8c2d00526a7678">mobilebackup2_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> *client)</td></tr>
59
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the mobilebackup2 service on the specified device.  <a href="#acafbe3a637937faead8c2d00526a7678"></a><br/></td></tr>
60
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a6476ab467a7319cf3d4882d995af41f6">mobilebackup2_client_free</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client)</td></tr>
61
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a mobilebackup2 client from the device and frees up the mobilebackup2 client data.  <a href="#a6476ab467a7319cf3d4882d995af41f6"></a><br/></td></tr>
62
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a127bbac1f1c6a0e289011902e3a7a3b0">mobilebackup2_receive_message</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client, plist_t *msg_plist, char **dlmessage)</td></tr>
63
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a DL* message plist from the device.  <a href="#a127bbac1f1c6a0e289011902e3a7a3b0"></a><br/></td></tr>
64
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#ac1c37c17849bf4f3f3240e7cc7b3514b">mobilebackup2_send_raw</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client, const char *data, uint32_t length, uint32_t *bytes)</td></tr>
65
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Send binary data to the device.  <a href="#ac1c37c17849bf4f3f3240e7cc7b3514b"></a><br/></td></tr>
66
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a27469291309887a60abbbafd1d90eac3">mobilebackup2_receive_raw</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client, char *data, uint32_t length, uint32_t *bytes)</td></tr>
67
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive binary from the device.  <a href="#a27469291309887a60abbbafd1d90eac3"></a><br/></td></tr>
68
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a46e04c64ba6f996c1bdea8e20f28cde2">mobilebackup2_version_exchange</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client, double local_versions[], char count, double *remote_version)</td></tr>
69
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the mobilebackup2 protocol version exchange.  <a href="#a46e04c64ba6f996c1bdea8e20f28cde2"></a><br/></td></tr>
70
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aad817475256ae8216718b32e1e6fd97d">mobilebackup2_send_request</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client, const char *request, const char *target_identifier, const char *source_identifier, plist_t options)</td></tr>
71
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a request to the connected mobilebackup2 service.  <a href="#aad817475256ae8216718b32e1e6fd97d"></a><br/></td></tr>
72
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeeb2bec4278c62a20b72bc31f8ac3329">mobilebackup2_send_status_response</a> (<a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> client, int status_code, const char *status1, plist_t status2)</td></tr>
73
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a DLMessageStatusResponse to the device.  <a href="#aeeb2bec4278c62a20b72bc31f8ac3329"></a><br/></td></tr>
74
 
<tr><td colspan="2"><h2><a name="member-group"></a>
 
69
<tr class="memitem:a7b563b99e3eba6d528f14f4948920085"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a7b563b99e3eba6d528f14f4948920085">mobilebackup2_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> *client)</td></tr>
 
70
<tr class="memdesc:a7b563b99e3eba6d528f14f4948920085"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the mobilebackup2 service on the specified device.  <a href="#a7b563b99e3eba6d528f14f4948920085"></a><br/></td></tr>
 
71
<tr class="memitem:a6476ab467a7319cf3d4882d995af41f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a6476ab467a7319cf3d4882d995af41f6">mobilebackup2_client_free</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client)</td></tr>
 
72
<tr class="memdesc:a6476ab467a7319cf3d4882d995af41f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a mobilebackup2 client from the device and frees up the mobilebackup2 client data.  <a href="#a6476ab467a7319cf3d4882d995af41f6"></a><br/></td></tr>
 
73
<tr class="memitem:a408732ff5a488ee2f72b4b7b3c671b24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a408732ff5a488ee2f72b4b7b3c671b24">mobilebackup2_send_message</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, const char *message, plist_t options)</td></tr>
 
74
<tr class="memdesc:a408732ff5a488ee2f72b4b7b3c671b24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a backup message plist.  <a href="#a408732ff5a488ee2f72b4b7b3c671b24"></a><br/></td></tr>
 
75
<tr class="memitem:a127bbac1f1c6a0e289011902e3a7a3b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a127bbac1f1c6a0e289011902e3a7a3b0">mobilebackup2_receive_message</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, plist_t *msg_plist, char **dlmessage)</td></tr>
 
76
<tr class="memdesc:a127bbac1f1c6a0e289011902e3a7a3b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a DL* message plist from the device.  <a href="#a127bbac1f1c6a0e289011902e3a7a3b0"></a><br/></td></tr>
 
77
<tr class="memitem:ac1c37c17849bf4f3f3240e7cc7b3514b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#ac1c37c17849bf4f3f3240e7cc7b3514b">mobilebackup2_send_raw</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, const char *data, uint32_t length, uint32_t *bytes)</td></tr>
 
78
<tr class="memdesc:ac1c37c17849bf4f3f3240e7cc7b3514b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send binary data to the device.  <a href="#ac1c37c17849bf4f3f3240e7cc7b3514b"></a><br/></td></tr>
 
79
<tr class="memitem:a27469291309887a60abbbafd1d90eac3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a27469291309887a60abbbafd1d90eac3">mobilebackup2_receive_raw</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, char *data, uint32_t length, uint32_t *bytes)</td></tr>
 
80
<tr class="memdesc:a27469291309887a60abbbafd1d90eac3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive binary from the device.  <a href="#a27469291309887a60abbbafd1d90eac3"></a><br/></td></tr>
 
81
<tr class="memitem:a46e04c64ba6f996c1bdea8e20f28cde2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a46e04c64ba6f996c1bdea8e20f28cde2">mobilebackup2_version_exchange</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, double local_versions[], char count, double *remote_version)</td></tr>
 
82
<tr class="memdesc:a46e04c64ba6f996c1bdea8e20f28cde2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the mobilebackup2 protocol version exchange.  <a href="#a46e04c64ba6f996c1bdea8e20f28cde2"></a><br/></td></tr>
 
83
<tr class="memitem:aad817475256ae8216718b32e1e6fd97d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aad817475256ae8216718b32e1e6fd97d">mobilebackup2_send_request</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, const char *request, const char *target_identifier, const char *source_identifier, plist_t options)</td></tr>
 
84
<tr class="memdesc:aad817475256ae8216718b32e1e6fd97d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a request to the connected mobilebackup2 service.  <a href="#aad817475256ae8216718b32e1e6fd97d"></a><br/></td></tr>
 
85
<tr class="memitem:aeeb2bec4278c62a20b72bc31f8ac3329"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeeb2bec4278c62a20b72bc31f8ac3329">mobilebackup2_send_status_response</a> (<a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> client, int status_code, const char *status1, plist_t status2)</td></tr>
 
86
<tr class="memdesc:aeeb2bec4278c62a20b72bc31f8ac3329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a DLMessageStatusResponse to the device.  <a href="#aeeb2bec4278c62a20b72bc31f8ac3329"></a><br/></td></tr>
 
87
</table><table class="memberdecls">
 
88
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
75
89
Error Codes</h2></td></tr>
76
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3f9e4ac7e3b77cfeee993e2507989cc"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_SUCCESS" ref="af3f9e4ac7e3b77cfeee993e2507989cc" args="" -->
 
90
<tr class="memitem:af3f9e4ac7e3b77cfeee993e2507989cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3f9e4ac7e3b77cfeee993e2507989cc"></a>
77
91
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_SUCCESS</b>&#160;&#160;&#160;0</td></tr>
78
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5f45440c865c20f4a8ac6afed6c063b"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_INVALID_ARG" ref="ab5f45440c865c20f4a8ac6afed6c063b" args="" -->
 
92
<tr class="memitem:ab5f45440c865c20f4a8ac6afed6c063b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5f45440c865c20f4a8ac6afed6c063b"></a>
79
93
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_INVALID_ARG</b>&#160;&#160;&#160;-1</td></tr>
80
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a789e6fc3b41ea74a5048da8b5c389952"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_PLIST_ERROR" ref="a789e6fc3b41ea74a5048da8b5c389952" args="" -->
 
94
<tr class="memitem:a789e6fc3b41ea74a5048da8b5c389952"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a789e6fc3b41ea74a5048da8b5c389952"></a>
81
95
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_PLIST_ERROR</b>&#160;&#160;&#160;-2</td></tr>
82
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3501f127fa0d5e9105f168b9d21b5079"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_MUX_ERROR" ref="a3501f127fa0d5e9105f168b9d21b5079" args="" -->
 
96
<tr class="memitem:a3501f127fa0d5e9105f168b9d21b5079"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3501f127fa0d5e9105f168b9d21b5079"></a>
83
97
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_MUX_ERROR</b>&#160;&#160;&#160;-3</td></tr>
84
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a817fa6e750c2f3d780b9e4c47d201eb2"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_BAD_VERSION" ref="a817fa6e750c2f3d780b9e4c47d201eb2" args="" -->
 
98
<tr class="memitem:a817fa6e750c2f3d780b9e4c47d201eb2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a817fa6e750c2f3d780b9e4c47d201eb2"></a>
85
99
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_BAD_VERSION</b>&#160;&#160;&#160;-4</td></tr>
86
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1241acd9624acdea8d615c7220468090"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_REPLY_NOT_OK" ref="a1241acd9624acdea8d615c7220468090" args="" -->
 
100
<tr class="memitem:a1241acd9624acdea8d615c7220468090"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1241acd9624acdea8d615c7220468090"></a>
87
101
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_REPLY_NOT_OK</b>&#160;&#160;&#160;-5</td></tr>
88
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c98cd4a42452f1eeb5edeb39d8d725c"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_NO_COMMON_VERSION" ref="a3c98cd4a42452f1eeb5edeb39d8d725c" args="" -->
 
102
<tr class="memitem:a3c98cd4a42452f1eeb5edeb39d8d725c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c98cd4a42452f1eeb5edeb39d8d725c"></a>
89
103
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_NO_COMMON_VERSION</b>&#160;&#160;&#160;-6</td></tr>
90
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bfa574f38e1f397a5af7a2dd6ee526e"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup2.h::MOBILEBACKUP2_E_UNKNOWN_ERROR" ref="a8bfa574f38e1f397a5af7a2dd6ee526e" args="" -->
 
104
<tr class="memitem:a8bfa574f38e1f397a5af7a2dd6ee526e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bfa574f38e1f397a5af7a2dd6ee526e"></a>
91
105
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP2_E_UNKNOWN_ERROR</b>&#160;&#160;&#160;-256</td></tr>
92
106
</table>
93
 
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
107
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
94
108
<div class="textblock"><p>Backup and restore of all device data (mobilebackup2, iOS4+ only) </p>
95
109
</div><hr/><h2>Typedef Documentation</h2>
96
 
<a class="anchor" id="a0cf69d4c02a02f37f1f864946aa4670a"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_client_t" ref="a0cf69d4c02a02f37f1f864946aa4670a" args="" -->
 
110
<a class="anchor" id="a0cf69d4c02a02f37f1f864946aa4670a"></a>
97
111
<div class="memitem">
98
112
<div class="memproto">
99
113
      <table class="memname">
100
114
        <tr>
101
 
          <td class="memname">typedef <a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_private</a>* <a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a></td>
 
115
          <td class="memname">typedef <a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_private</a>* <a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a></td>
102
116
        </tr>
103
117
      </table>
104
 
</div>
105
 
<div class="memdoc">
 
118
</div><div class="memdoc">
106
119
 
107
120
<p>The client handle. </p>
108
121
 
109
122
</div>
110
123
</div>
111
 
<a class="anchor" id="aeae49da50c4638bd5a3178e9a4b00a2e"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_error_t" ref="aeae49da50c4638bd5a3178e9a4b00a2e" args="" -->
 
124
<a class="anchor" id="aeae49da50c4638bd5a3178e9a4b00a2e"></a>
112
125
<div class="memitem">
113
126
<div class="memproto">
114
127
      <table class="memname">
116
129
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a></td>
117
130
        </tr>
118
131
      </table>
119
 
</div>
120
 
<div class="memdoc">
 
132
</div><div class="memdoc">
121
133
 
122
134
<p>Represents an error code. </p>
123
135
 
124
136
</div>
125
137
</div>
126
138
<hr/><h2>Function Documentation</h2>
127
 
<a class="anchor" id="a6476ab467a7319cf3d4882d995af41f6"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_client_free" ref="a6476ab467a7319cf3d4882d995af41f6" args="(mobilebackup2_client_t client)" -->
 
139
<a class="anchor" id="a6476ab467a7319cf3d4882d995af41f6"></a>
128
140
<div class="memitem">
129
141
<div class="memproto">
130
142
      <table class="memname">
131
143
        <tr>
132
144
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_client_free </td>
133
145
          <td>(</td>
134
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
146
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
135
147
          <td class="paramname"><em>client</em></td><td>)</td>
136
148
          <td></td>
137
149
        </tr>
138
150
      </table>
139
 
</div>
140
 
<div class="memdoc">
 
151
</div><div class="memdoc">
141
152
 
142
153
<p>Disconnects a mobilebackup2 client from the device and frees up the mobilebackup2 client data. </p>
143
 
<dl><dt><b>Parameters:</b></dt><dd>
 
154
<dl class="params"><dt>Parameters:</dt><dd>
144
155
  <table class="params">
145
156
    <tr><td class="paramname">client</td><td>The mobilebackup2 client to disconnect and free.</td></tr>
146
157
  </table>
147
158
  </dd>
148
159
</dl>
149
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS on success, or MOBILEBACKUP2_E_INVALID_ARG if client is NULL. </dd></dl>
 
160
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS on success, or MOBILEBACKUP2_E_INVALID_ARG if client is NULL. </dd></dl>
150
161
 
151
162
</div>
152
163
</div>
153
 
<a class="anchor" id="acafbe3a637937faead8c2d00526a7678"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_client_new" ref="acafbe3a637937faead8c2d00526a7678" args="(idevice_t device, uint16_t port, mobilebackup2_client_t *client)" -->
 
164
<a class="anchor" id="a7b563b99e3eba6d528f14f4948920085"></a>
154
165
<div class="memitem">
155
166
<div class="memproto">
156
167
      <table class="memname">
157
168
        <tr>
158
169
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_client_new </td>
159
170
          <td>(</td>
160
 
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&#160;</td>
 
171
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
161
172
          <td class="paramname"><em>device</em>, </td>
162
173
        </tr>
163
174
        <tr>
164
175
          <td class="paramkey"></td>
165
176
          <td></td>
166
 
          <td class="paramtype">uint16_t&#160;</td>
167
 
          <td class="paramname"><em>port</em>, </td>
 
177
          <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
 
178
          <td class="paramname"><em>service</em>, </td>
168
179
        </tr>
169
180
        <tr>
170
181
          <td class="paramkey"></td>
171
182
          <td></td>
172
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a> *&#160;</td>
 
183
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a> *&#160;</td>
173
184
          <td class="paramname"><em>client</em>&#160;</td>
174
185
        </tr>
175
186
        <tr>
178
189
          <td></td><td></td>
179
190
        </tr>
180
191
      </table>
181
 
</div>
182
 
<div class="memdoc">
 
192
</div><div class="memdoc">
183
193
 
184
194
<p>Connects to the mobilebackup2 service on the specified device. </p>
185
 
<dl><dt><b>Parameters:</b></dt><dd>
 
195
<dl class="params"><dt>Parameters:</dt><dd>
186
196
  <table class="params">
187
197
    <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
188
 
    <tr><td class="paramname">port</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
 
198
    <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
189
199
    <tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated mobilebackup2_client_t upon successful return.</td></tr>
190
200
  </table>
191
201
  </dd>
192
202
</dl>
193
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS on success, MOBILEBACKUP2_E_INVALID ARG if one or more parameter is invalid, or MOBILEBACKUP2_E_BAD_VERSION if the mobilebackup2 version on the device is newer. </dd></dl>
 
203
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS on success, MOBILEBACKUP2_E_INVALID ARG if one or more parameter is invalid, or MOBILEBACKUP2_E_BAD_VERSION if the mobilebackup2 version on the device is newer. </dd></dl>
194
204
 
195
205
</div>
196
206
</div>
197
 
<a class="anchor" id="a127bbac1f1c6a0e289011902e3a7a3b0"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_receive_message" ref="a127bbac1f1c6a0e289011902e3a7a3b0" args="(mobilebackup2_client_t client, plist_t *msg_plist, char **dlmessage)" -->
 
207
<a class="anchor" id="a127bbac1f1c6a0e289011902e3a7a3b0"></a>
198
208
<div class="memitem">
199
209
<div class="memproto">
200
210
      <table class="memname">
201
211
        <tr>
202
212
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_receive_message </td>
203
213
          <td>(</td>
204
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
214
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
205
215
          <td class="paramname"><em>client</em>, </td>
206
216
        </tr>
207
217
        <tr>
222
232
          <td></td><td></td>
223
233
        </tr>
224
234
      </table>
225
 
</div>
226
 
<div class="memdoc">
 
235
</div><div class="memdoc">
227
236
 
228
237
<p>Receives a DL* message plist from the device. </p>
229
238
<p>This function is a wrapper around device_link_service_receive_message.</p>
230
 
<dl><dt><b>Parameters:</b></dt><dd>
 
239
<dl class="params"><dt>Parameters:</dt><dd>
231
240
  <table class="params">
232
241
    <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
233
242
    <tr><td class="paramname">msg_plist</td><td>Pointer to a plist that will be set to the contents of the message plist upon successful return. </td></tr>
235
244
  </table>
236
245
  </dd>
237
246
</dl>
238
 
<dl class="return"><dt><b>Returns:</b></dt><dd>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. </dd></dl>
 
247
<dl class="section return"><dt>Returns:</dt><dd>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. </dd></dl>
239
248
 
240
249
</div>
241
250
</div>
242
 
<a class="anchor" id="a27469291309887a60abbbafd1d90eac3"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_receive_raw" ref="a27469291309887a60abbbafd1d90eac3" args="(mobilebackup2_client_t client, char *data, uint32_t length, uint32_t *bytes)" -->
 
251
<a class="anchor" id="a27469291309887a60abbbafd1d90eac3"></a>
243
252
<div class="memitem">
244
253
<div class="memproto">
245
254
      <table class="memname">
246
255
        <tr>
247
256
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_receive_raw </td>
248
257
          <td>(</td>
249
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
258
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
250
259
          <td class="paramname"><em>client</em>, </td>
251
260
        </tr>
252
261
        <tr>
273
282
          <td></td><td></td>
274
283
        </tr>
275
284
      </table>
276
 
</div>
277
 
<div class="memdoc">
 
285
</div><div class="memdoc">
278
286
 
279
287
<p>Receive binary from the device. </p>
280
 
<dl class="note"><dt><b>Note:</b></dt><dd>This function returns MOBILEBACKUP2_E_SUCCESS even if no data has been received (unless a communication error occured). The fourth parameter is required and must be checked to know how many bytes were actually received.</dd></dl>
281
 
<dl><dt><b>Parameters:</b></dt><dd>
 
288
<dl class="section note"><dt>Note:</dt><dd>This function returns MOBILEBACKUP2_E_SUCCESS even if no data has been received (unless a communication error occured). The fourth parameter is required and must be checked to know how many bytes were actually received.</dd></dl>
 
289
<dl class="params"><dt>Parameters:</dt><dd>
282
290
  <table class="params">
283
291
    <tr><td class="paramname">client</td><td>The MobileBackup client to receive from. </td></tr>
284
292
    <tr><td class="paramname">data</td><td>Pointer to a buffer that will be filled with the received data. </td></tr>
286
294
  </table>
287
295
  </dd>
288
296
</dl>
289
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS if any or no data was received, MOBILEBACKUP2_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP2_E_MUX_ERROR if receiving the data failed. </dd></dl>
290
 
 
291
 
</div>
292
 
</div>
293
 
<a class="anchor" id="ac1c37c17849bf4f3f3240e7cc7b3514b"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_send_raw" ref="ac1c37c17849bf4f3f3240e7cc7b3514b" args="(mobilebackup2_client_t client, const char *data, uint32_t length, uint32_t *bytes)" -->
 
297
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS if any or no data was received, MOBILEBACKUP2_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP2_E_MUX_ERROR if receiving the data failed. </dd></dl>
 
298
 
 
299
</div>
 
300
</div>
 
301
<a class="anchor" id="a408732ff5a488ee2f72b4b7b3c671b24"></a>
 
302
<div class="memitem">
 
303
<div class="memproto">
 
304
      <table class="memname">
 
305
        <tr>
 
306
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_send_message </td>
 
307
          <td>(</td>
 
308
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
 
309
          <td class="paramname"><em>client</em>, </td>
 
310
        </tr>
 
311
        <tr>
 
312
          <td class="paramkey"></td>
 
313
          <td></td>
 
314
          <td class="paramtype">const char *&#160;</td>
 
315
          <td class="paramname"><em>message</em>, </td>
 
316
        </tr>
 
317
        <tr>
 
318
          <td class="paramkey"></td>
 
319
          <td></td>
 
320
          <td class="paramtype">plist_t&#160;</td>
 
321
          <td class="paramname"><em>options</em>&#160;</td>
 
322
        </tr>
 
323
        <tr>
 
324
          <td></td>
 
325
          <td>)</td>
 
326
          <td></td><td></td>
 
327
        </tr>
 
328
      </table>
 
329
</div><div class="memdoc">
 
330
 
 
331
<p>Sends a backup message plist. </p>
 
332
<dl class="params"><dt>Parameters:</dt><dd>
 
333
  <table class="params">
 
334
    <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
 
335
    <tr><td class="paramname">message</td><td>The message to send. This will be inserted into the request plist as value for MessageName. If this parameter is NULL, the plist passed in the options parameter will be sent directly. </td></tr>
 
336
    <tr><td class="paramname">options</td><td>Additional options as PLIST_DICT to add to the request. The MessageName key with the value passed in the message parameter will be inserted into this plist before sending it. This parameter can be NULL if message is not NULL. </td></tr>
 
337
  </table>
 
338
  </dd>
 
339
</dl>
 
340
 
 
341
</div>
 
342
</div>
 
343
<a class="anchor" id="ac1c37c17849bf4f3f3240e7cc7b3514b"></a>
294
344
<div class="memitem">
295
345
<div class="memproto">
296
346
      <table class="memname">
297
347
        <tr>
298
348
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_send_raw </td>
299
349
          <td>(</td>
300
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
350
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
301
351
          <td class="paramname"><em>client</em>, </td>
302
352
        </tr>
303
353
        <tr>
324
374
          <td></td><td></td>
325
375
        </tr>
326
376
      </table>
327
 
</div>
328
 
<div class="memdoc">
 
377
</div><div class="memdoc">
329
378
 
330
379
<p>Send binary data to the device. </p>
331
 
<dl class="note"><dt><b>Note:</b></dt><dd>This function returns MOBILEBACKUP2_E_SUCCESS even if less than the requested length has been sent. The fourth parameter is required and must be checked to ensure if the whole data has been sent.</dd></dl>
332
 
<dl><dt><b>Parameters:</b></dt><dd>
 
380
<dl class="section note"><dt>Note:</dt><dd>This function returns MOBILEBACKUP2_E_SUCCESS even if less than the requested length has been sent. The fourth parameter is required and must be checked to ensure if the whole data has been sent.</dd></dl>
 
381
<dl class="params"><dt>Parameters:</dt><dd>
333
382
  <table class="params">
334
383
    <tr><td class="paramname">client</td><td>The MobileBackup client to send to. </td></tr>
335
384
    <tr><td class="paramname">data</td><td>Pointer to the data to send </td></tr>
338
387
  </table>
339
388
  </dd>
340
389
</dl>
341
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS if any data was successfully sent, MOBILEBACKUP2_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP2_E_MUX_ERROR if sending of the data failed. </dd></dl>
 
390
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS if any data was successfully sent, MOBILEBACKUP2_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP2_E_MUX_ERROR if sending of the data failed. </dd></dl>
342
391
 
343
392
</div>
344
393
</div>
345
 
<a class="anchor" id="aad817475256ae8216718b32e1e6fd97d"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_send_request" ref="aad817475256ae8216718b32e1e6fd97d" args="(mobilebackup2_client_t client, const char *request, const char *target_identifier, const char *source_identifier, plist_t options)" -->
 
394
<a class="anchor" id="aad817475256ae8216718b32e1e6fd97d"></a>
346
395
<div class="memitem">
347
396
<div class="memproto">
348
397
      <table class="memname">
349
398
        <tr>
350
399
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_send_request </td>
351
400
          <td>(</td>
352
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
401
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
353
402
          <td class="paramname"><em>client</em>, </td>
354
403
        </tr>
355
404
        <tr>
382
431
          <td></td><td></td>
383
432
        </tr>
384
433
      </table>
385
 
</div>
386
 
<div class="memdoc">
 
434
</div><div class="memdoc">
387
435
 
388
436
<p>Send a request to the connected mobilebackup2 service. </p>
389
 
<dl><dt><b>Parameters:</b></dt><dd>
 
437
<dl class="params"><dt>Parameters:</dt><dd>
390
438
  <table class="params">
391
439
    <tr><td class="paramname">client</td><td></td></tr>
392
440
    <tr><td class="paramname">request</td><td>The request to send to the backup service. Currently, this is one of "Backup", "Restore", "Info", or "List". </td></tr>
393
 
    <tr><td class="paramname">target_identifier</td><td>UUID of the target device. </td></tr>
394
 
    <tr><td class="paramname">source_identifier</td><td>UUID of backup data? </td></tr>
 
441
    <tr><td class="paramname">target_identifier</td><td>UDID of the target device. </td></tr>
 
442
    <tr><td class="paramname">source_identifier</td><td>UDID of backup data? </td></tr>
395
443
    <tr><td class="paramname">options</td><td>Additional options in a plist of type PLIST_DICT.</td></tr>
396
444
  </table>
397
445
  </dd>
398
446
</dl>
399
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS if the request was successfully sent, or a MOBILEBACKUP2_E_* error value otherwise. </dd></dl>
 
447
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS if the request was successfully sent, or a MOBILEBACKUP2_E_* error value otherwise. </dd></dl>
400
448
 
401
449
</div>
402
450
</div>
403
 
<a class="anchor" id="aeeb2bec4278c62a20b72bc31f8ac3329"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_send_status_response" ref="aeeb2bec4278c62a20b72bc31f8ac3329" args="(mobilebackup2_client_t client, int status_code, const char *status1, plist_t status2)" -->
 
451
<a class="anchor" id="aeeb2bec4278c62a20b72bc31f8ac3329"></a>
404
452
<div class="memitem">
405
453
<div class="memproto">
406
454
      <table class="memname">
407
455
        <tr>
408
456
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_send_status_response </td>
409
457
          <td>(</td>
410
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
458
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
411
459
          <td class="paramname"><em>client</em>, </td>
412
460
        </tr>
413
461
        <tr>
434
482
          <td></td><td></td>
435
483
        </tr>
436
484
      </table>
437
 
</div>
438
 
<div class="memdoc">
 
485
</div><div class="memdoc">
439
486
 
440
487
<p>Sends a DLMessageStatusResponse to the device. </p>
441
 
<dl><dt><b>Parameters:</b></dt><dd>
 
488
<dl class="params"><dt>Parameters:</dt><dd>
442
489
  <table class="params">
443
490
    <tr><td class="paramname">client</td><td>The MobileBackup client to use. </td></tr>
444
491
    <tr><td class="paramname">status_code</td><td>The status code to send. </td></tr>
447
494
  </table>
448
495
  </dd>
449
496
</dl>
450
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS on success, MOBILEBACKUP2_E_INVALID_ARG if client is invalid, or another MOBILEBACKUP2_E_* otherwise. </dd></dl>
 
497
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS on success, MOBILEBACKUP2_E_INVALID_ARG if client is invalid, or another MOBILEBACKUP2_E_* otherwise. </dd></dl>
451
498
 
452
499
</div>
453
500
</div>
454
 
<a class="anchor" id="a46e04c64ba6f996c1bdea8e20f28cde2"></a><!-- doxytag: member="mobilebackup2.h::mobilebackup2_version_exchange" ref="a46e04c64ba6f996c1bdea8e20f28cde2" args="(mobilebackup2_client_t client, double local_versions[], char count, double *remote_version)" -->
 
501
<a class="anchor" id="a46e04c64ba6f996c1bdea8e20f28cde2"></a>
455
502
<div class="memitem">
456
503
<div class="memproto">
457
504
      <table class="memname">
458
505
        <tr>
459
506
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#aeae49da50c4638bd5a3178e9a4b00a2e">mobilebackup2_error_t</a> mobilebackup2_version_exchange </td>
460
507
          <td>(</td>
461
 
          <td class="paramtype"><a class="el" href="structmobilebackup2__client__private.html">mobilebackup2_client_t</a>&#160;</td>
 
508
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilebackup2_8h.html#a0cf69d4c02a02f37f1f864946aa4670a">mobilebackup2_client_t</a>&#160;</td>
462
509
          <td class="paramname"><em>client</em>, </td>
463
510
        </tr>
464
511
        <tr>
485
532
          <td></td><td></td>
486
533
        </tr>
487
534
      </table>
488
 
</div>
489
 
<div class="memdoc">
 
535
</div><div class="memdoc">
490
536
 
491
537
<p>Performs the mobilebackup2 protocol version exchange. </p>
492
 
<dl><dt><b>Parameters:</b></dt><dd>
 
538
<dl class="params"><dt>Parameters:</dt><dd>
493
539
  <table class="params">
494
540
    <tr><td class="paramname">client</td><td>The MobileBackup client to use. </td></tr>
495
541
    <tr><td class="paramname">local_versions</td><td>An array of supported versions to send to the remote. </td></tr>
498
544
  </table>
499
545
  </dd>
500
546
</dl>
501
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP2_E_SUCCESS on success, or a MOBILEBACKUP2_E_* error code otherwise. </dd></dl>
 
547
<dl class="section return"><dt>Returns:</dt><dd>MOBILEBACKUP2_E_SUCCESS on success, or a MOBILEBACKUP2_E_* error code otherwise. </dd></dl>
502
548
 
503
549
</div>
504
550
</div>
505
 
</div>
506
 
<hr class="footer"/><address class="footer"><small>Generated by&#160;
507
 
<a href="http://www.doxygen.org/index.html">
508
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
 
551
</div><!-- contents -->
 
552
<!-- start footer part -->
 
553
<hr class="footer"/><address class="footer"><small>
 
554
Generated by &#160;<a href="http://www.doxygen.org/index.html">
 
555
<img class="footer" src="doxygen.png" alt="doxygen"/>
 
556
</a> 1.8.1
 
557
</small></address>
509
558
</body>
510
559
</html>