| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560 |
- <!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/restore.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="#typedef-members">Typedefs</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">restore.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Initiate restore process or reboot device.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:a2fa5ec6259ec43dc9ff90a3f47485829"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fa5ec6259ec43dc9ff90a3f47485829"></a>
- typedef struct <br class="typebreak" />
- restored_client_private </td><td class="memItemRight" valign="bottom"><b>restored_client_private</b></td></tr>
- <tr class="separator:a2fa5ec6259ec43dc9ff90a3f47485829"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aff695f5a0fca031139acd46da18f76ee"><td class="memItemLeft" align="right" valign="top">typedef restored_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a></td></tr>
- <tr class="memdesc:aff695f5a0fca031139acd46da18f76ee"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#aff695f5a0fca031139acd46da18f76ee">More...</a><br /></td></tr>
- <tr class="separator:aff695f5a0fca031139acd46da18f76ee"><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:a4eeb68bf8b54e5ce3998d70e8c9e4465"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4eeb68bf8b54e5ce3998d70e8c9e4465"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> { <br />
-   <b>RESTORE_E_SUCCESS</b> = 0,
- <br />
-   <b>RESTORE_E_INVALID_ARG</b> = -1,
- <br />
-   <b>RESTORE_E_INVALID_CONF</b> = -2,
- <br />
-   <b>RESTORE_E_PLIST_ERROR</b> = -3,
- <br />
-   <b>RESTORE_E_DICT_ERROR</b> = -4,
- <br />
-   <b>RESTORE_E_NOT_ENOUGH_DATA</b> = -5,
- <br />
-   <b>RESTORE_E_MUX_ERROR</b> = -6,
- <br />
-   <b>RESTORE_E_START_RESTORE_FAILED</b> = -7,
- <br />
-   <b>RESTORE_E_DEVICE_ERROR</b> = -8,
- <br />
-   <b>RESTORE_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a4eeb68bf8b54e5ce3998d70e8c9e4465"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a4eeb68bf8b54e5ce3998d70e8c9e4465"><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:ae48fd93e4676c8da83e325d7a8632171"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#ae48fd93e4676c8da83e325d7a8632171">restored_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> *client, const char *label)</td></tr>
- <tr class="memdesc:ae48fd93e4676c8da83e325d7a8632171"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new restored client for the device. <a href="#ae48fd93e4676c8da83e325d7a8632171">More...</a><br /></td></tr>
- <tr class="separator:ae48fd93e4676c8da83e325d7a8632171"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a31f0ea30ff3c1dc1c278651082a68799"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a31f0ea30ff3c1dc1c278651082a68799">restored_client_free</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client)</td></tr>
- <tr class="memdesc:a31f0ea30ff3c1dc1c278651082a68799"><td class="mdescLeft"> </td><td class="mdescRight">Closes the restored client session if one is running and frees up the restored_client struct. <a href="#a31f0ea30ff3c1dc1c278651082a68799">More...</a><br /></td></tr>
- <tr class="separator:a31f0ea30ff3c1dc1c278651082a68799"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a721a655aa5ceb038e64e27c6eedd8e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a721a655aa5ceb038e64e27c6eedd8e93">restored_query_type</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, char **type, uint64_t *version)</td></tr>
- <tr class="memdesc:a721a655aa5ceb038e64e27c6eedd8e93"><td class="mdescLeft"> </td><td class="mdescRight">Query the type of the service daemon. <a href="#a721a655aa5ceb038e64e27c6eedd8e93">More...</a><br /></td></tr>
- <tr class="separator:a721a655aa5ceb038e64e27c6eedd8e93"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afc54a6e3cd9ab65f5b19b876af8f4d9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#afc54a6e3cd9ab65f5b19b876af8f4d9e">restored_query_value</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, const char *key, plist_t *value)</td></tr>
- <tr class="memdesc:afc54a6e3cd9ab65f5b19b876af8f4d9e"><td class="mdescLeft"> </td><td class="mdescRight">Queries a value from the device specified by a key. <a href="#afc54a6e3cd9ab65f5b19b876af8f4d9e">More...</a><br /></td></tr>
- <tr class="separator:afc54a6e3cd9ab65f5b19b876af8f4d9e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a27ca68e6ea555d762a77e3962be54b30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a27ca68e6ea555d762a77e3962be54b30">restored_get_value</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, const char *key, plist_t *value)</td></tr>
- <tr class="memdesc:a27ca68e6ea555d762a77e3962be54b30"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a value from information plist specified by a key. <a href="#a27ca68e6ea555d762a77e3962be54b30">More...</a><br /></td></tr>
- <tr class="separator:a27ca68e6ea555d762a77e3962be54b30"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4c96e75072960cafe91487d3abd45c43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a4c96e75072960cafe91487d3abd45c43">restored_send</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, plist_t plist)</td></tr>
- <tr class="memdesc:a4c96e75072960cafe91487d3abd45c43"><td class="mdescLeft"> </td><td class="mdescRight">Sends a plist to restored. <a href="#a4c96e75072960cafe91487d3abd45c43">More...</a><br /></td></tr>
- <tr class="separator:a4c96e75072960cafe91487d3abd45c43"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a889d8d1d868512480e2411d3dc326537"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a889d8d1d868512480e2411d3dc326537">restored_receive</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, plist_t *plist)</td></tr>
- <tr class="memdesc:a889d8d1d868512480e2411d3dc326537"><td class="mdescLeft"> </td><td class="mdescRight">Receives a plist from restored. <a href="#a889d8d1d868512480e2411d3dc326537">More...</a><br /></td></tr>
- <tr class="separator:a889d8d1d868512480e2411d3dc326537"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7906a9859425151520367017366f70c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a7906a9859425151520367017366f70c0">restored_goodbye</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client)</td></tr>
- <tr class="memdesc:a7906a9859425151520367017366f70c0"><td class="mdescLeft"> </td><td class="mdescRight">Sends the Goodbye request to restored signaling the end of communication. <a href="#a7906a9859425151520367017366f70c0">More...</a><br /></td></tr>
- <tr class="separator:a7906a9859425151520367017366f70c0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6b6fdd815fc17cd247ebbdea7f5a1ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#ac6b6fdd815fc17cd247ebbdea7f5a1ed">restored_start_restore</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, plist_t options, uint64_t version)</td></tr>
- <tr class="memdesc:ac6b6fdd815fc17cd247ebbdea7f5a1ed"><td class="mdescLeft"> </td><td class="mdescRight">Requests to start a restore and retrieve it's port on success. <a href="#ac6b6fdd815fc17cd247ebbdea7f5a1ed">More...</a><br /></td></tr>
- <tr class="separator:ac6b6fdd815fc17cd247ebbdea7f5a1ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a71c6802f2f40f379235fa02279c02c3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a71c6802f2f40f379235fa02279c02c3b">restored_reboot</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client)</td></tr>
- <tr class="memdesc:a71c6802f2f40f379235fa02279c02c3b"><td class="mdescLeft"> </td><td class="mdescRight">Requests device to reboot. <a href="#a71c6802f2f40f379235fa02279c02c3b">More...</a><br /></td></tr>
- <tr class="separator:a71c6802f2f40f379235fa02279c02c3b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ace88ccae3670668bacfce22e8b164ce5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#ace88ccae3670668bacfce22e8b164ce5">restored_client_set_label</a> (<a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> client, const char *label)</td></tr>
- <tr class="memdesc:ace88ccae3670668bacfce22e8b164ce5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the label to send for requests to restored. <a href="#ace88ccae3670668bacfce22e8b164ce5">More...</a><br /></td></tr>
- <tr class="separator:ace88ccae3670668bacfce22e8b164ce5"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Initiate restore process or reboot device. </p>
- <dl class="section note"><dt>Note</dt><dd>This service is only available if the device is in restore mode. </dd></dl>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="aff695f5a0fca031139acd46da18f76ee"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef restored_client_private* <a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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="a31f0ea30ff3c1dc1c278651082a68799"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Closes the restored client session if one is running and frees up the restored_client struct. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restore client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ae48fd93e4676c8da83e325d7a8632171"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_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"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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>Creates a new restored client for the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to create a restored client for </td></tr>
- <tr><td class="paramname">client</td><td>The pointer to the location of the new restored_client </td></tr>
- <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ace88ccae3670668bacfce22e8b164ce5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void restored_client_set_label </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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>Sets the label to send for requests to restored. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restore client </td></tr>
- <tr><td class="paramname">label</td><td>The label to set or NULL to disable sending a label </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a27ca68e6ea555d762a77e3962be54b30"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_get_value </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Retrieves a value from information plist specified by a key. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>An initialized restored client. </td></tr>
- <tr><td class="paramname">key</td><td>The key name to request or NULL to query for all keys </td></tr>
- <tr><td class="paramname">value</td><td>A plist node representing the result value node</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7906a9859425151520367017366f70c0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_goodbye </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends the Goodbye request to restored signaling the end of communication. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restore client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a721a655aa5ceb038e64e27c6eedd8e93"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_query_type </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>type</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t * </td>
- <td class="paramname"><em>version</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Query the type of the service daemon. </p>
- <p>Depending on whether the device is queried in normal mode or restore mode, different types will be returned.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restored client </td></tr>
- <tr><td class="paramname">type</td><td>The type returned by the service daemon. Pass NULL to ignore. </td></tr>
- <tr><td class="paramname">version</td><td>The restore protocol version. Pass NULL to ignore.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="afc54a6e3cd9ab65f5b19b876af8f4d9e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_query_value </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Queries a value from the device specified by a key. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>An initialized restored client. </td></tr>
- <tr><td class="paramname">key</td><td>The key name to request </td></tr>
- <tr><td class="paramname">value</td><td>A plist node representing the result value node</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a71c6802f2f40f379235fa02279c02c3b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_reboot </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Requests device to reboot. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restored client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a889d8d1d868512480e2411d3dc326537"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_receive </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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>Receives a plist from restored. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restored client </td></tr>
- <tr><td class="paramname">plist</td><td>The plist to store the received data</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client or plist is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a4c96e75072960cafe91487d3abd45c43"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_send </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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 a plist to restored. </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 restored client </td></tr>
- <tr><td class="paramname">plist</td><td>The plist to send</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client or plist is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ac6b6fdd815fc17cd247ebbdea7f5a1ed"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_start_restore </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_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>options</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>version</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Requests to start a restore and retrieve it's port on success. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The restored client </td></tr>
- <tr><td class="paramname">options</td><td>PLIST_DICT with options for the restore process or NULL </td></tr>
- <tr><td class="paramname">version</td><td>the restore protocol version, see <a class="el" href="restore_8h.html#a721a655aa5ceb038e64e27c6eedd8e93" title="Query the type of the service daemon. ">restored_query_type()</a></td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter is NULL, RESTORE_E_START_RESTORE_FAILED if the request fails </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>
|