restore_8h.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>libimobiledevice: libimobiledevice/restore.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">libimobiledevice
  21. &#160;<span id="projectnumber">1.2.0</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  34. <li class="current"><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="files.html"><span>File&#160;List</span></a></li>
  40. <li><a href="globals.html"><span>Globals</span></a></li>
  41. </ul>
  42. </div>
  43. <div id="nav-path" class="navpath">
  44. <ul>
  45. <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
  46. </div>
  47. </div><!-- top -->
  48. <div class="header">
  49. <div class="summary">
  50. <a href="#typedef-members">Typedefs</a> &#124;
  51. <a href="#enum-members">Enumerations</a> &#124;
  52. <a href="#func-members">Functions</a> </div>
  53. <div class="headertitle">
  54. <div class="title">restore.h File Reference</div> </div>
  55. </div><!--header-->
  56. <div class="contents">
  57. <p>Initiate restore process or reboot device.
  58. <a href="#details">More...</a></p>
  59. <table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  61. Typedefs</h2></td></tr>
  62. <tr class="memitem:a2fa5ec6259ec43dc9ff90a3f47485829"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fa5ec6259ec43dc9ff90a3f47485829"></a>
  63. typedef struct <br class="typebreak" />
  64. restored_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>restored_client_private</b></td></tr>
  65. <tr class="separator:a2fa5ec6259ec43dc9ff90a3f47485829"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:aff695f5a0fca031139acd46da18f76ee"><td class="memItemLeft" align="right" valign="top">typedef restored_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a></td></tr>
  67. <tr class="memdesc:aff695f5a0fca031139acd46da18f76ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#aff695f5a0fca031139acd46da18f76ee">More...</a><br /></td></tr>
  68. <tr class="separator:aff695f5a0fca031139acd46da18f76ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. </table><table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  71. Enumerations</h2></td></tr>
  72. <tr class="memitem:a4eeb68bf8b54e5ce3998d70e8c9e4465"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4eeb68bf8b54e5ce3998d70e8c9e4465"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> { <br />
  73. &#160;&#160;<b>RESTORE_E_SUCCESS</b> = 0,
  74. <br />
  75. &#160;&#160;<b>RESTORE_E_INVALID_ARG</b> = -1,
  76. <br />
  77. &#160;&#160;<b>RESTORE_E_INVALID_CONF</b> = -2,
  78. <br />
  79. &#160;&#160;<b>RESTORE_E_PLIST_ERROR</b> = -3,
  80. <br />
  81. &#160;&#160;<b>RESTORE_E_DICT_ERROR</b> = -4,
  82. <br />
  83. &#160;&#160;<b>RESTORE_E_NOT_ENOUGH_DATA</b> = -5,
  84. <br />
  85. &#160;&#160;<b>RESTORE_E_MUX_ERROR</b> = -6,
  86. <br />
  87. &#160;&#160;<b>RESTORE_E_START_RESTORE_FAILED</b> = -7,
  88. <br />
  89. &#160;&#160;<b>RESTORE_E_DEVICE_ERROR</b> = -8,
  90. <br />
  91. &#160;&#160;<b>RESTORE_E_UNKNOWN_ERROR</b> = -256
  92. <br />
  93. }</td></tr>
  94. <tr class="memdesc:a4eeb68bf8b54e5ce3998d70e8c9e4465"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  95. <tr class="separator:a4eeb68bf8b54e5ce3998d70e8c9e4465"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table><table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  98. Functions</h2></td></tr>
  99. <tr class="memitem:ae48fd93e4676c8da83e325d7a8632171"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  100. <tr class="memdesc:ae48fd93e4676c8da83e325d7a8632171"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new restored client for the device. <a href="#ae48fd93e4676c8da83e325d7a8632171">More...</a><br /></td></tr>
  101. <tr class="separator:ae48fd93e4676c8da83e325d7a8632171"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a31f0ea30ff3c1dc1c278651082a68799"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  103. <tr class="memdesc:a31f0ea30ff3c1dc1c278651082a68799"><td class="mdescLeft">&#160;</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>
  104. <tr class="separator:a31f0ea30ff3c1dc1c278651082a68799"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a721a655aa5ceb038e64e27c6eedd8e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  106. <tr class="memdesc:a721a655aa5ceb038e64e27c6eedd8e93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query the type of the service daemon. <a href="#a721a655aa5ceb038e64e27c6eedd8e93">More...</a><br /></td></tr>
  107. <tr class="separator:a721a655aa5ceb038e64e27c6eedd8e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:afc54a6e3cd9ab65f5b19b876af8f4d9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  109. <tr class="memdesc:afc54a6e3cd9ab65f5b19b876af8f4d9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queries a value from the device specified by a key. <a href="#afc54a6e3cd9ab65f5b19b876af8f4d9e">More...</a><br /></td></tr>
  110. <tr class="separator:afc54a6e3cd9ab65f5b19b876af8f4d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a27ca68e6ea555d762a77e3962be54b30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  112. <tr class="memdesc:a27ca68e6ea555d762a77e3962be54b30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a value from information plist specified by a key. <a href="#a27ca68e6ea555d762a77e3962be54b30">More...</a><br /></td></tr>
  113. <tr class="separator:a27ca68e6ea555d762a77e3962be54b30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a4c96e75072960cafe91487d3abd45c43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  115. <tr class="memdesc:a4c96e75072960cafe91487d3abd45c43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a plist to restored. <a href="#a4c96e75072960cafe91487d3abd45c43">More...</a><br /></td></tr>
  116. <tr class="separator:a4c96e75072960cafe91487d3abd45c43"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a889d8d1d868512480e2411d3dc326537"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  118. <tr class="memdesc:a889d8d1d868512480e2411d3dc326537"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a plist from restored. <a href="#a889d8d1d868512480e2411d3dc326537">More...</a><br /></td></tr>
  119. <tr class="separator:a889d8d1d868512480e2411d3dc326537"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a7906a9859425151520367017366f70c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  121. <tr class="memdesc:a7906a9859425151520367017366f70c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the Goodbye request to restored signaling the end of communication. <a href="#a7906a9859425151520367017366f70c0">More...</a><br /></td></tr>
  122. <tr class="separator:a7906a9859425151520367017366f70c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ac6b6fdd815fc17cd247ebbdea7f5a1ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  124. <tr class="memdesc:ac6b6fdd815fc17cd247ebbdea7f5a1ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests to start a restore and retrieve it's port on success. <a href="#ac6b6fdd815fc17cd247ebbdea7f5a1ed">More...</a><br /></td></tr>
  125. <tr class="separator:ac6b6fdd815fc17cd247ebbdea7f5a1ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a71c6802f2f40f379235fa02279c02c3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a>&#160;</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>
  127. <tr class="memdesc:a71c6802f2f40f379235fa02279c02c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests device to reboot. <a href="#a71c6802f2f40f379235fa02279c02c3b">More...</a><br /></td></tr>
  128. <tr class="separator:a71c6802f2f40f379235fa02279c02c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ace88ccae3670668bacfce22e8b164ce5"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  130. <tr class="memdesc:ace88ccae3670668bacfce22e8b164ce5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the label to send for requests to restored. <a href="#ace88ccae3670668bacfce22e8b164ce5">More...</a><br /></td></tr>
  131. <tr class="separator:ace88ccae3670668bacfce22e8b164ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table>
  133. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  134. <div class="textblock"><p>Initiate restore process or reboot device. </p>
  135. <dl class="section note"><dt>Note</dt><dd>This service is only available if the device is in restore mode. </dd></dl>
  136. </div><h2 class="groupheader">Typedef Documentation</h2>
  137. <a class="anchor" id="aff695f5a0fca031139acd46da18f76ee"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">typedef restored_client_private* <a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>The client handle. </p>
  147. </div>
  148. </div>
  149. <h2 class="groupheader">Function Documentation</h2>
  150. <a class="anchor" id="a31f0ea30ff3c1dc1c278651082a68799"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_client_free </td>
  156. <td>(</td>
  157. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  158. <td class="paramname"><em>client</em></td><td>)</td>
  159. <td></td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Closes the restored client session if one is running and frees up the restored_client struct. </p>
  164. <dl class="params"><dt>Parameters</dt><dd>
  165. <table class="params">
  166. <tr><td class="paramname">client</td><td>The restore client</td></tr>
  167. </table>
  168. </dd>
  169. </dl>
  170. <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL </dd></dl>
  171. </div>
  172. </div>
  173. <a class="anchor" id="ae48fd93e4676c8da83e325d7a8632171"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_client_new </td>
  179. <td>(</td>
  180. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  181. <td class="paramname"><em>device</em>, </td>
  182. </tr>
  183. <tr>
  184. <td class="paramkey"></td>
  185. <td></td>
  186. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a> *&#160;</td>
  187. <td class="paramname"><em>client</em>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">const char *&#160;</td>
  193. <td class="paramname"><em>label</em>&#160;</td>
  194. </tr>
  195. <tr>
  196. <td></td>
  197. <td>)</td>
  198. <td></td><td></td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Creates a new restored client for the device. </p>
  203. <dl class="params"><dt>Parameters</dt><dd>
  204. <table class="params">
  205. <tr><td class="paramname">device</td><td>The device to create a restored client for </td></tr>
  206. <tr><td class="paramname">client</td><td>The pointer to the location of the new restored_client </td></tr>
  207. <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name.</td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="ace88ccae3670668bacfce22e8b164ce5"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">void restored_client_set_label </td>
  220. <td>(</td>
  221. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  222. <td class="paramname"><em>client</em>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype">const char *&#160;</td>
  228. <td class="paramname"><em>label</em>&#160;</td>
  229. </tr>
  230. <tr>
  231. <td></td>
  232. <td>)</td>
  233. <td></td><td></td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Sets the label to send for requests to restored. </p>
  238. <dl class="params"><dt>Parameters</dt><dd>
  239. <table class="params">
  240. <tr><td class="paramname">client</td><td>The restore client </td></tr>
  241. <tr><td class="paramname">label</td><td>The label to set or NULL to disable sending a label </td></tr>
  242. </table>
  243. </dd>
  244. </dl>
  245. </div>
  246. </div>
  247. <a class="anchor" id="a27ca68e6ea555d762a77e3962be54b30"></a>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_get_value </td>
  253. <td>(</td>
  254. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  255. <td class="paramname"><em>client</em>, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype">const char *&#160;</td>
  261. <td class="paramname"><em>key</em>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">plist_t *&#160;</td>
  267. <td class="paramname"><em>value</em>&#160;</td>
  268. </tr>
  269. <tr>
  270. <td></td>
  271. <td>)</td>
  272. <td></td><td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Retrieves a value from information plist specified by a key. </p>
  277. <dl class="params"><dt>Parameters</dt><dd>
  278. <table class="params">
  279. <tr><td class="paramname">client</td><td>An initialized restored client. </td></tr>
  280. <tr><td class="paramname">key</td><td>The key name to request or NULL to query for all keys </td></tr>
  281. <tr><td class="paramname">value</td><td>A plist node representing the result value node</td></tr>
  282. </table>
  283. </dd>
  284. </dl>
  285. <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>
  286. </div>
  287. </div>
  288. <a class="anchor" id="a7906a9859425151520367017366f70c0"></a>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_goodbye </td>
  294. <td>(</td>
  295. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  296. <td class="paramname"><em>client</em></td><td>)</td>
  297. <td></td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Sends the Goodbye request to restored signaling the end of communication. </p>
  302. <dl class="params"><dt>Parameters</dt><dd>
  303. <table class="params">
  304. <tr><td class="paramname">client</td><td>The restore client</td></tr>
  305. </table>
  306. </dd>
  307. </dl>
  308. <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>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a721a655aa5ceb038e64e27c6eedd8e93"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_query_type </td>
  317. <td>(</td>
  318. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  319. <td class="paramname"><em>client</em>, </td>
  320. </tr>
  321. <tr>
  322. <td class="paramkey"></td>
  323. <td></td>
  324. <td class="paramtype">char **&#160;</td>
  325. <td class="paramname"><em>type</em>, </td>
  326. </tr>
  327. <tr>
  328. <td class="paramkey"></td>
  329. <td></td>
  330. <td class="paramtype">uint64_t *&#160;</td>
  331. <td class="paramname"><em>version</em>&#160;</td>
  332. </tr>
  333. <tr>
  334. <td></td>
  335. <td>)</td>
  336. <td></td><td></td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>Query the type of the service daemon. </p>
  341. <p>Depending on whether the device is queried in normal mode or restore mode, different types will be returned.</p>
  342. <dl class="params"><dt>Parameters</dt><dd>
  343. <table class="params">
  344. <tr><td class="paramname">client</td><td>The restored client </td></tr>
  345. <tr><td class="paramname">type</td><td>The type returned by the service daemon. Pass NULL to ignore. </td></tr>
  346. <tr><td class="paramname">version</td><td>The restore protocol version. Pass NULL to ignore.</td></tr>
  347. </table>
  348. </dd>
  349. </dl>
  350. <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL </dd></dl>
  351. </div>
  352. </div>
  353. <a class="anchor" id="afc54a6e3cd9ab65f5b19b876af8f4d9e"></a>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_query_value </td>
  359. <td>(</td>
  360. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  361. <td class="paramname"><em>client</em>, </td>
  362. </tr>
  363. <tr>
  364. <td class="paramkey"></td>
  365. <td></td>
  366. <td class="paramtype">const char *&#160;</td>
  367. <td class="paramname"><em>key</em>, </td>
  368. </tr>
  369. <tr>
  370. <td class="paramkey"></td>
  371. <td></td>
  372. <td class="paramtype">plist_t *&#160;</td>
  373. <td class="paramname"><em>value</em>&#160;</td>
  374. </tr>
  375. <tr>
  376. <td></td>
  377. <td>)</td>
  378. <td></td><td></td>
  379. </tr>
  380. </table>
  381. </div><div class="memdoc">
  382. <p>Queries a value from the device specified by a key. </p>
  383. <dl class="params"><dt>Parameters</dt><dd>
  384. <table class="params">
  385. <tr><td class="paramname">client</td><td>An initialized restored client. </td></tr>
  386. <tr><td class="paramname">key</td><td>The key name to request </td></tr>
  387. <tr><td class="paramname">value</td><td>A plist node representing the result value node</td></tr>
  388. </table>
  389. </dd>
  390. </dl>
  391. <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>
  392. </div>
  393. </div>
  394. <a class="anchor" id="a71c6802f2f40f379235fa02279c02c3b"></a>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="memname">
  398. <tr>
  399. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_reboot </td>
  400. <td>(</td>
  401. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  402. <td class="paramname"><em>client</em></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Requests device to reboot. </p>
  408. <dl class="params"><dt>Parameters</dt><dd>
  409. <table class="params">
  410. <tr><td class="paramname">client</td><td>The restored client</td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. <dl class="section return"><dt>Returns</dt><dd>RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter is NULL </dd></dl>
  415. </div>
  416. </div>
  417. <a class="anchor" id="a889d8d1d868512480e2411d3dc326537"></a>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_receive </td>
  423. <td>(</td>
  424. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  425. <td class="paramname"><em>client</em>, </td>
  426. </tr>
  427. <tr>
  428. <td class="paramkey"></td>
  429. <td></td>
  430. <td class="paramtype">plist_t *&#160;</td>
  431. <td class="paramname"><em>plist</em>&#160;</td>
  432. </tr>
  433. <tr>
  434. <td></td>
  435. <td>)</td>
  436. <td></td><td></td>
  437. </tr>
  438. </table>
  439. </div><div class="memdoc">
  440. <p>Receives a plist from restored. </p>
  441. <dl class="params"><dt>Parameters</dt><dd>
  442. <table class="params">
  443. <tr><td class="paramname">client</td><td>The restored client </td></tr>
  444. <tr><td class="paramname">plist</td><td>The plist to store the received data</td></tr>
  445. </table>
  446. </dd>
  447. </dl>
  448. <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>
  449. </div>
  450. </div>
  451. <a class="anchor" id="a4c96e75072960cafe91487d3abd45c43"></a>
  452. <div class="memitem">
  453. <div class="memproto">
  454. <table class="memname">
  455. <tr>
  456. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_send </td>
  457. <td>(</td>
  458. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  459. <td class="paramname"><em>client</em>, </td>
  460. </tr>
  461. <tr>
  462. <td class="paramkey"></td>
  463. <td></td>
  464. <td class="paramtype">plist_t&#160;</td>
  465. <td class="paramname"><em>plist</em>&#160;</td>
  466. </tr>
  467. <tr>
  468. <td></td>
  469. <td>)</td>
  470. <td></td><td></td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. <p>Sends a plist to restored. </p>
  475. <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>
  476. <dl class="params"><dt>Parameters</dt><dd>
  477. <table class="params">
  478. <tr><td class="paramname">client</td><td>The restored client </td></tr>
  479. <tr><td class="paramname">plist</td><td>The plist to send</td></tr>
  480. </table>
  481. </dd>
  482. </dl>
  483. <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>
  484. </div>
  485. </div>
  486. <a class="anchor" id="ac6b6fdd815fc17cd247ebbdea7f5a1ed"></a>
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname"><a class="el" href="restore_8h.html#a4eeb68bf8b54e5ce3998d70e8c9e4465">restored_error_t</a> restored_start_restore </td>
  492. <td>(</td>
  493. <td class="paramtype"><a class="el" href="restore_8h.html#aff695f5a0fca031139acd46da18f76ee">restored_client_t</a>&#160;</td>
  494. <td class="paramname"><em>client</em>, </td>
  495. </tr>
  496. <tr>
  497. <td class="paramkey"></td>
  498. <td></td>
  499. <td class="paramtype">plist_t&#160;</td>
  500. <td class="paramname"><em>options</em>, </td>
  501. </tr>
  502. <tr>
  503. <td class="paramkey"></td>
  504. <td></td>
  505. <td class="paramtype">uint64_t&#160;</td>
  506. <td class="paramname"><em>version</em>&#160;</td>
  507. </tr>
  508. <tr>
  509. <td></td>
  510. <td>)</td>
  511. <td></td><td></td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. <p>Requests to start a restore and retrieve it's port on success. </p>
  516. <dl class="params"><dt>Parameters</dt><dd>
  517. <table class="params">
  518. <tr><td class="paramname">client</td><td>The restored client </td></tr>
  519. <tr><td class="paramname">options</td><td>PLIST_DICT with options for the restore process or NULL </td></tr>
  520. <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>
  521. </table>
  522. </dd>
  523. </dl>
  524. <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>
  525. </div>
  526. </div>
  527. </div><!-- contents -->
  528. <!-- start footer part -->
  529. <hr class="footer"/><address class="footer"><small>
  530. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  531. <img class="footer" src="doxygen.png" alt="doxygen"/>
  532. </a> 1.8.8
  533. </small></address>
  534. </body>
  535. </html>