| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.8"/>
- <title>libimobiledevice: libimobiledevice/mobilebackup.h File Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">libimobiledevice
-  <span id="projectnumber">1.2.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.8 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#define-members">Macros</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">mobilebackup.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Backup and restore of all device data.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:ad4179f0791327356e6aeb1a8aedf7794"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4179f0791327356e6aeb1a8aedf7794"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_SERVICE_NAME</b>   "com.apple.mobilebackup"</td></tr>
- <tr class="separator:ad4179f0791327356e6aeb1a8aedf7794"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:aa3178d164fe65038c4314ac45a2a6953"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3178d164fe65038c4314ac45a2a6953"></a>
- typedef struct <br class="typebreak" />
- mobilebackup_client_private </td><td class="memItemRight" valign="bottom"><b>mobilebackup_client_private</b></td></tr>
- <tr class="separator:aa3178d164fe65038c4314ac45a2a6953"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a80c8c3310e73ac1ac6cdb565635a9af8"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
- mobilebackup_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a></td></tr>
- <tr class="memdesc:a80c8c3310e73ac1ac6cdb565635a9af8"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a80c8c3310e73ac1ac6cdb565635a9af8">More...</a><br /></td></tr>
- <tr class="separator:a80c8c3310e73ac1ac6cdb565635a9af8"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:a871f2dcf590edff5b17156a464784e9f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a871f2dcf590edff5b17156a464784e9f"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> { <br />
-   <b>MOBILEBACKUP_E_SUCCESS</b> = 0,
- <br />
-   <b>MOBILEBACKUP_E_INVALID_ARG</b> = -1,
- <br />
-   <b>MOBILEBACKUP_E_PLIST_ERROR</b> = -2,
- <br />
-   <b>MOBILEBACKUP_E_MUX_ERROR</b> = -3,
- <br />
-   <b>MOBILEBACKUP_E_BAD_VERSION</b> = -4,
- <br />
-   <b>MOBILEBACKUP_E_REPLY_NOT_OK</b> = -5,
- <br />
-   <b>MOBILEBACKUP_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a871f2dcf590edff5b17156a464784e9f"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a871f2dcf590edff5b17156a464784e9f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a901e0f8f2cd63280b9a9d68bd7e8c23d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a901e0f8f2cd63280b9a9d68bd7e8c23d"></a>enum  </td><td class="memItemRight" valign="bottom"><b>mobilebackup_flags_t</b> { <br />
-   <b>MB_RESTORE_NOTIFY_SPRINGBOARD</b> = 1 << 0,
- <br />
-   <b>MB_RESTORE_PRESERVE_SETTINGS</b> = 1 << 1,
- <br />
-   <b>MB_RESTORE_PRESERVE_CAMERA_ROLL</b> = 1 << 2
- <br />
- }</td></tr>
- <tr class="separator:a901e0f8f2cd63280b9a9d68bd7e8c23d"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a7f7b7933f7a312a28e701e9bd1825f02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a7f7b7933f7a312a28e701e9bd1825f02">mobilebackup_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> *client)</td></tr>
- <tr class="memdesc:a7f7b7933f7a312a28e701e9bd1825f02"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the mobilebackup service on the specified device. <a href="#a7f7b7933f7a312a28e701e9bd1825f02">More...</a><br /></td></tr>
- <tr class="separator:a7f7b7933f7a312a28e701e9bd1825f02"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad448008226608f4636b713b8cbd20c04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#ad448008226608f4636b713b8cbd20c04">mobilebackup_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> *client, const char *label)</td></tr>
- <tr class="memdesc:ad448008226608f4636b713b8cbd20c04"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new mobilebackup service on the specified device and connects to it. <a href="#ad448008226608f4636b713b8cbd20c04">More...</a><br /></td></tr>
- <tr class="separator:ad448008226608f4636b713b8cbd20c04"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aceff0d79d743e3b9e2974ef1ff298c6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#aceff0d79d743e3b9e2974ef1ff298c6f">mobilebackup_client_free</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client)</td></tr>
- <tr class="memdesc:aceff0d79d743e3b9e2974ef1ff298c6f"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects a mobilebackup client from the device and frees up the mobilebackup client data. <a href="#aceff0d79d743e3b9e2974ef1ff298c6f">More...</a><br /></td></tr>
- <tr class="separator:aceff0d79d743e3b9e2974ef1ff298c6f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab141879e1be237c2b3e3b739fe31b6b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#ab141879e1be237c2b3e3b739fe31b6b5">mobilebackup_receive</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t *plist)</td></tr>
- <tr class="memdesc:ab141879e1be237c2b3e3b739fe31b6b5"><td class="mdescLeft"> </td><td class="mdescRight">Polls the device for mobilebackup data. <a href="#ab141879e1be237c2b3e3b739fe31b6b5">More...</a><br /></td></tr>
- <tr class="separator:ab141879e1be237c2b3e3b739fe31b6b5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a868886fd24134178fea043e5cbaa3a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a868886fd24134178fea043e5cbaa3a75">mobilebackup_send</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t plist)</td></tr>
- <tr class="memdesc:a868886fd24134178fea043e5cbaa3a75"><td class="mdescLeft"> </td><td class="mdescRight">Sends mobilebackup data to the device. <a href="#a868886fd24134178fea043e5cbaa3a75">More...</a><br /></td></tr>
- <tr class="separator:a868886fd24134178fea043e5cbaa3a75"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a22a4ffba65451178d42251643edf7cb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a22a4ffba65451178d42251643edf7cb8">mobilebackup_request_backup</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t backup_manifest, const char *base_path, const char *proto_version)</td></tr>
- <tr class="memdesc:a22a4ffba65451178d42251643edf7cb8"><td class="mdescLeft"> </td><td class="mdescRight">Request a backup from the connected device. <a href="#a22a4ffba65451178d42251643edf7cb8">More...</a><br /></td></tr>
- <tr class="separator:a22a4ffba65451178d42251643edf7cb8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a684dd7ebb0111f8a8ca7ab4119199be9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a684dd7ebb0111f8a8ca7ab4119199be9">mobilebackup_send_backup_file_received</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client)</td></tr>
- <tr class="memdesc:a684dd7ebb0111f8a8ca7ab4119199be9"><td class="mdescLeft"> </td><td class="mdescRight">Sends a confirmation to the device that a backup file has been received. <a href="#a684dd7ebb0111f8a8ca7ab4119199be9">More...</a><br /></td></tr>
- <tr class="separator:a684dd7ebb0111f8a8ca7ab4119199be9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac09e0685762314ea1c1f8ffcfc623975"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#ac09e0685762314ea1c1f8ffcfc623975">mobilebackup_request_restore</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t backup_manifest, mobilebackup_flags_t flags, const char *proto_version)</td></tr>
- <tr class="memdesc:ac09e0685762314ea1c1f8ffcfc623975"><td class="mdescLeft"> </td><td class="mdescRight">Request that a backup should be restored to the connected device. <a href="#ac09e0685762314ea1c1f8ffcfc623975">More...</a><br /></td></tr>
- <tr class="separator:ac09e0685762314ea1c1f8ffcfc623975"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97467648d4c5d77bc7f1fbe23722a61e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a97467648d4c5d77bc7f1fbe23722a61e">mobilebackup_receive_restore_file_received</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t *result)</td></tr>
- <tr class="memdesc:a97467648d4c5d77bc7f1fbe23722a61e"><td class="mdescLeft"> </td><td class="mdescRight">Receive a confirmation from the device that it successfully received a restore file. <a href="#a97467648d4c5d77bc7f1fbe23722a61e">More...</a><br /></td></tr>
- <tr class="separator:a97467648d4c5d77bc7f1fbe23722a61e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7cef0478b30d26fbd0a5f146815e202e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a7cef0478b30d26fbd0a5f146815e202e">mobilebackup_receive_restore_application_received</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t *result)</td></tr>
- <tr class="memdesc:a7cef0478b30d26fbd0a5f146815e202e"><td class="mdescLeft"> </td><td class="mdescRight">Receive a confirmation from the device that it successfully received application data file. <a href="#a7cef0478b30d26fbd0a5f146815e202e">More...</a><br /></td></tr>
- <tr class="separator:a7cef0478b30d26fbd0a5f146815e202e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adb1ef11295238147532e84878b924a5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#adb1ef11295238147532e84878b924a5e">mobilebackup_send_restore_complete</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client)</td></tr>
- <tr class="memdesc:adb1ef11295238147532e84878b924a5e"><td class="mdescLeft"> </td><td class="mdescRight">Tells the device that the restore process is complete and waits for the device to close the connection. <a href="#adb1ef11295238147532e84878b924a5e">More...</a><br /></td></tr>
- <tr class="separator:adb1ef11295238147532e84878b924a5e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a68249f2d882e0264bdd45ea2abf1e6d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a68249f2d882e0264bdd45ea2abf1e6d1">mobilebackup_send_error</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, const char *reason)</td></tr>
- <tr class="memdesc:a68249f2d882e0264bdd45ea2abf1e6d1"><td class="mdescLeft"> </td><td class="mdescRight">Sends a backup error message to the device. <a href="#a68249f2d882e0264bdd45ea2abf1e6d1">More...</a><br /></td></tr>
- <tr class="separator:a68249f2d882e0264bdd45ea2abf1e6d1"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Backup and restore of all device data. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a80c8c3310e73ac1ac6cdb565635a9af8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef mobilebackup_client_private* <a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The client handle. </p>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="aceff0d79d743e3b9e2974ef1ff298c6f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disconnects a mobilebackup client from the device and frees up the mobilebackup client data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilebackup client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, or MOBILEBACKUP_E_INVALID_ARG if client is NULL. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7f7b7933f7a312a28e701e9bd1825f02"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_client_new </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">lockdownd_service_descriptor_t </td>
- <td class="paramname"><em>service</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> * </td>
- <td class="paramname"><em>client</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connects to the mobilebackup service on the specified device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated mobilebackup_client_t upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID ARG if one or more parameters are invalid, or DEVICE_LINK_SERVICE_E_BAD_VERSION if the mobilebackup version on the device is newer. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad448008226608f4636b713b8cbd20c04"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_client_start_service </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> * </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>label</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts a new mobilebackup service on the specified device and connects to it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated mobilebackup_client_t upon successful return. Must be freed using <a class="el" href="mobilebackup_8h.html#aceff0d79d743e3b9e2974ef1ff298c6f" title="Disconnects a mobilebackup client from the device and frees up the mobilebackup client data...">mobilebackup_client_free()</a> after use. </td></tr>
- <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, or an MOBILEBACKUP_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab141879e1be237c2b3e3b739fe31b6b5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_receive </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>plist</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Polls the device for mobilebackup data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilebackup client </td></tr>
- <tr><td class="paramname">plist</td><td>A pointer to the location where the plist should be stored</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>an error code </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7cef0478b30d26fbd0a5f146815e202e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_receive_restore_application_received </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>result</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receive a confirmation from the device that it successfully received application data file. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
- <tr><td class="paramname">result</td><td>Pointer to a plist_t that will be set to the received plist for further processing. The caller has to free it using plist_free(). Note that it will be set to NULL if the operation itself fails due to a communication or plist error. If this parameter is NULL, it will be ignored.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, MOBILEBACKUP_E_REPLY_NOT_OK if the expected 'BackupMessageRestoreApplicationReceived' message could not be received, MOBILEBACKUP_E_PLIST_ERROR if the received message is not a valid backup message plist, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a97467648d4c5d77bc7f1fbe23722a61e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_receive_restore_file_received </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>result</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receive a confirmation from the device that it successfully received a restore file. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
- <tr><td class="paramname">result</td><td>Pointer to a plist_t that will be set to the received plist for further processing. The caller has to free it using plist_free(). Note that it will be set to NULL if the operation itself fails due to a communication or plist error. If this parameter is NULL, it will be ignored.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, MOBILEBACKUP_E_REPLY_NOT_OK if the expected 'BackupMessageRestoreFileReceived' message could not be received, MOBILEBACKUP_E_PLIST_ERROR if the received message is not a valid backup message plist, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a22a4ffba65451178d42251643edf7cb8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_request_backup </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>backup_manifest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>base_path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>proto_version</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request a backup from the connected device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
- <tr><td class="paramname">backup_manifest</td><td>The backup manifest, a plist_t of type PLIST_DICT containing the backup state of the last backup. For a first-time backup set this parameter to NULL. </td></tr>
- <tr><td class="paramname">base_path</td><td>The base path on the device to use for the backup operation, usually "/". </td></tr>
- <tr><td class="paramname">proto_version</td><td>A string denoting the version of the backup protocol to use. Latest known version is "1.6"</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, MOBILEBACKUP_E_PLIST_ERROR if backup_manifest is not of type PLIST_DICT, MOBILEBACKUP_E_MUX_ERROR if a communication error occurs, MOBILEBACKUP_E_REPLY_NOT_OK </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ac09e0685762314ea1c1f8ffcfc623975"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_request_restore </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>backup_manifest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">mobilebackup_flags_t </td>
- <td class="paramname"><em>flags</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>proto_version</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request that a backup should be restored to the connected device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
- <tr><td class="paramname">backup_manifest</td><td>The backup manifest, a plist_t of type PLIST_DICT containing the backup state to be restored. </td></tr>
- <tr><td class="paramname">flags</td><td>Flags to send with the request. Currently this is a combination of the following mobilebackup_flags_t: MB_RESTORE_NOTIFY_SPRINGBOARD - let SpringBoard show a 'Restore' screen MB_RESTORE_PRESERVE_SETTINGS - do not overwrite any settings MB_RESTORE_PRESERVE_CAMERA_ROLL - preserve the photos of the camera roll </td></tr>
- <tr><td class="paramname">proto_version</td><td>A string denoting the version of the backup protocol to use. Latest known version is "1.6". Ideally this value should be extracted from the given manifest plist.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, MOBILEBACKUP_E_PLIST_ERROR if backup_manifest is not of type PLIST_DICT, MOBILEBACKUP_E_MUX_ERROR if a communication error occurs, or MOBILEBACKUP_E_REPLY_NOT_OK if the device did not accept the request. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a868886fd24134178fea043e5cbaa3a75"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>plist</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends mobilebackup data to the device. </p>
- <dl class="section note"><dt>Note</dt><dd>This function is low-level and should only be used if you need to send a new type of message.</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilebackup client </td></tr>
- <tr><td class="paramname">plist</td><td>The location of the plist to send</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>an error code </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a684dd7ebb0111f8a8ca7ab4119199be9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send_backup_file_received </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a confirmation to the device that a backup file has been received. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a68249f2d882e0264bdd45ea2abf1e6d1"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send_error </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>reason</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a backup error message to the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
- <tr><td class="paramname">reason</td><td>A string describing the reason for the error message.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="adb1ef11295238147532e84878b924a5e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send_restore_complete </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Tells the device that the restore process is complete and waits for the device to close the connection. </p>
- <p>After that, the device should reboot.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected MobileBackup client to use.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, MOBILEBACKUP_E_PLIST_ERROR if the received disconnect message plist is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.8
- </small></address>
- </body>
- </html>
|