house__arrest_8h.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  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/house_arrest.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="#define-members">Macros</a> &#124;
  51. <a href="#typedef-members">Typedefs</a> &#124;
  52. <a href="#enum-members">Enumerations</a> &#124;
  53. <a href="#func-members">Functions</a> </div>
  54. <div class="headertitle">
  55. <div class="title">house_arrest.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Access app folders and their contents.
  59. <a href="#details">More...</a></p>
  60. <table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  62. Macros</h2></td></tr>
  63. <tr class="memitem:a0acdbeac5a5d74e75eadf03c829abdbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0acdbeac5a5d74e75eadf03c829abdbb"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobile.house_arrest&quot;</td></tr>
  65. <tr class="separator:a0acdbeac5a5d74e75eadf03c829abdbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table><table class="memberdecls">
  67. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  68. Typedefs</h2></td></tr>
  69. <tr class="memitem:aba8ce3e4a71343138317a458e8066e94"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba8ce3e4a71343138317a458e8066e94"></a>
  70. typedef struct <br class="typebreak" />
  71. house_arrest_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>house_arrest_client_private</b></td></tr>
  72. <tr class="separator:aba8ce3e4a71343138317a458e8066e94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a66fc0910d9ae304fe23848f0547d3baf"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  74. house_arrest_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a></td></tr>
  75. <tr class="memdesc:a66fc0910d9ae304fe23848f0547d3baf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#a66fc0910d9ae304fe23848f0547d3baf">More...</a><br /></td></tr>
  76. <tr class="separator:a66fc0910d9ae304fe23848f0547d3baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. </table><table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  79. Enumerations</h2></td></tr>
  80. <tr class="memitem:a6afca9f79e3a3af7d52db5bf2e3125d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6afca9f79e3a3af7d52db5bf2e3125d1"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> { <br />
  81. &#160;&#160;<b>HOUSE_ARREST_E_SUCCESS</b> = 0,
  82. <br />
  83. &#160;&#160;<b>HOUSE_ARREST_E_INVALID_ARG</b> = -1,
  84. <br />
  85. &#160;&#160;<b>HOUSE_ARREST_E_PLIST_ERROR</b> = -2,
  86. <br />
  87. &#160;&#160;<b>HOUSE_ARREST_E_CONN_FAILED</b> = -3,
  88. <br />
  89. &#160;&#160;<b>HOUSE_ARREST_E_INVALID_MODE</b> = -4,
  90. <br />
  91. &#160;&#160;<b>HOUSE_ARREST_E_UNKNOWN_ERROR</b> = -256
  92. <br />
  93. }</td></tr>
  94. <tr class="memdesc:a6afca9f79e3a3af7d52db5bf2e3125d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  95. <tr class="separator:a6afca9f79e3a3af7d52db5bf2e3125d1"><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:a9d5feb409ee90b6763153f73f0899920"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a9d5feb409ee90b6763153f73f0899920">house_arrest_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> *client)</td></tr>
  100. <tr class="memdesc:a9d5feb409ee90b6763153f73f0899920"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the house_arrest service on the specified device. <a href="#a9d5feb409ee90b6763153f73f0899920">More...</a><br /></td></tr>
  101. <tr class="separator:a9d5feb409ee90b6763153f73f0899920"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ac05b9c75d4cf605cf3b6b51478a49a36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#ac05b9c75d4cf605cf3b6b51478a49a36">house_arrest_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> *client, const char *label)</td></tr>
  103. <tr class="memdesc:ac05b9c75d4cf605cf3b6b51478a49a36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new house_arrest service on the specified device and connects to it. <a href="#ac05b9c75d4cf605cf3b6b51478a49a36">More...</a><br /></td></tr>
  104. <tr class="separator:ac05b9c75d4cf605cf3b6b51478a49a36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ab48e57565d1e5ca52351a3ebc24b73a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#ab48e57565d1e5ca52351a3ebc24b73a8">house_arrest_client_free</a> (<a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> client)</td></tr>
  106. <tr class="memdesc:ab48e57565d1e5ca52351a3ebc24b73a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects an house_arrest client from the device and frees up the house_arrest client data. <a href="#ab48e57565d1e5ca52351a3ebc24b73a8">More...</a><br /></td></tr>
  107. <tr class="separator:ab48e57565d1e5ca52351a3ebc24b73a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ac8f8df58815b4ccc6c9a875f67d52463"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#ac8f8df58815b4ccc6c9a875f67d52463">house_arrest_send_request</a> (<a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> client, plist_t dict)</td></tr>
  109. <tr class="memdesc:ac8f8df58815b4ccc6c9a875f67d52463"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a generic request to the connected house_arrest service. <a href="#ac8f8df58815b4ccc6c9a875f67d52463">More...</a><br /></td></tr>
  110. <tr class="separator:ac8f8df58815b4ccc6c9a875f67d52463"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a0442d85e903b4784c6344d2e71507dc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a0442d85e903b4784c6344d2e71507dc3">house_arrest_send_command</a> (<a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> client, const char *command, const char *appid)</td></tr>
  112. <tr class="memdesc:a0442d85e903b4784c6344d2e71507dc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the connected house_arrest service. <a href="#a0442d85e903b4784c6344d2e71507dc3">More...</a><br /></td></tr>
  113. <tr class="separator:a0442d85e903b4784c6344d2e71507dc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a81f22f46c2707f0a6fe7e59126c10e74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74">house_arrest_get_result</a> (<a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> client, plist_t *dict)</td></tr>
  115. <tr class="memdesc:a81f22f46c2707f0a6fe7e59126c10e74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the result of a previously sent house_arrest_request_* request. <a href="#a81f22f46c2707f0a6fe7e59126c10e74">More...</a><br /></td></tr>
  116. <tr class="separator:a81f22f46c2707f0a6fe7e59126c10e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a46e202a2bcfa7ef82e362f3bc98a3f49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a46e202a2bcfa7ef82e362f3bc98a3f49">afc_client_new_from_house_arrest_client</a> (<a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> client, <a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> *afc_client)</td></tr>
  118. <tr class="memdesc:a46e202a2bcfa7ef82e362f3bc98a3f49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an AFC client using the given house_arrest client's connection allowing file access to a specific application directory requested by functions like house_arrest_request_vendor_documents(). <a href="#a46e202a2bcfa7ef82e362f3bc98a3f49">More...</a><br /></td></tr>
  119. <tr class="separator:a46e202a2bcfa7ef82e362f3bc98a3f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <div class="textblock"><p>Access app folders and their contents. </p>
  123. </div><h2 class="groupheader">Typedef Documentation</h2>
  124. <a class="anchor" id="a66fc0910d9ae304fe23848f0547d3baf"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">typedef house_arrest_client_private* <a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>The client handle. </p>
  134. </div>
  135. </div>
  136. <h2 class="groupheader">Function Documentation</h2>
  137. <a class="anchor" id="a46e202a2bcfa7ef82e362f3bc98a3f49"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_client_new_from_house_arrest_client </td>
  143. <td>(</td>
  144. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a>&#160;</td>
  145. <td class="paramname"><em>client</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> *&#160;</td>
  151. <td class="paramname"><em>afc_client</em>&#160;</td>
  152. </tr>
  153. <tr>
  154. <td></td>
  155. <td>)</td>
  156. <td></td><td></td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <p>Creates an AFC client using the given house_arrest client's connection allowing file access to a specific application directory requested by functions like house_arrest_request_vendor_documents(). </p>
  161. <dl class="params"><dt>Parameters</dt><dd>
  162. <table class="params">
  163. <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
  164. <tr><td class="paramname">afc_client</td><td>Pointer that will be set to a newly allocated afc_client_t upon successful return.</td></tr>
  165. </table>
  166. </dd>
  167. </dl>
  168. <dl class="section note"><dt>Note</dt><dd>After calling this function the house_arrest client will go in an AFC mode that will only allow calling <a class="el" href="house__arrest_8h.html#ab48e57565d1e5ca52351a3ebc24b73a8" title="Disconnects an house_arrest client from the device and frees up the house_arrest client data...">house_arrest_client_free()</a>. Only call <a class="el" href="house__arrest_8h.html#ab48e57565d1e5ca52351a3ebc24b73a8" title="Disconnects an house_arrest client from the device and frees up the house_arrest client data...">house_arrest_client_free()</a> if all AFC operations have completed since it will close the connection.</dd></dl>
  169. <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS if the afc client was successfully created, AFC_E_INVALID_ARG if client is invalid or was already used to create an afc client, or an AFC_E_* error code returned by afc_client_new_with_service_client(). </dd></dl>
  170. </div>
  171. </div>
  172. <a class="anchor" id="ab48e57565d1e5ca52351a3ebc24b73a8"></a>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_client_free </td>
  178. <td>(</td>
  179. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a>&#160;</td>
  180. <td class="paramname"><em>client</em></td><td>)</td>
  181. <td></td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Disconnects an house_arrest client from the device and frees up the house_arrest client data. </p>
  186. <dl class="section note"><dt>Note</dt><dd>After using <a class="el" href="house__arrest_8h.html#a46e202a2bcfa7ef82e362f3bc98a3f49" title="Creates an AFC client using the given house_arrest client&#39;s connection allowing file access to a spec...">afc_client_new_from_house_arrest_client()</a>, make sure you call <a class="el" href="afc_8h.html#a1cee6b357bdd7f187b7411a41c136412" title="Frees up an AFC client. ">afc_client_free()</a> before calling this function to ensure a proper cleanup. Do not call this function if you still need to perform AFC operations since it will close the connection.</dd></dl>
  187. <dl class="params"><dt>Parameters</dt><dd>
  188. <table class="params">
  189. <tr><td class="paramname">client</td><td>The house_arrest client to disconnect and free.</td></tr>
  190. </table>
  191. </dd>
  192. </dl>
  193. <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when client is NULL, or an HOUSE_ARREST_E_* error code otherwise. </dd></dl>
  194. </div>
  195. </div>
  196. <a class="anchor" id="a9d5feb409ee90b6763153f73f0899920"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_client_new </td>
  202. <td>(</td>
  203. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  204. <td class="paramname"><em>device</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  210. <td class="paramname"><em>service</em>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> *&#160;</td>
  216. <td class="paramname"><em>client</em>&#160;</td>
  217. </tr>
  218. <tr>
  219. <td></td>
  220. <td>)</td>
  221. <td></td><td></td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Connects to the house_arrest service on the specified device. </p>
  226. <dl class="params"><dt>Parameters</dt><dd>
  227. <table class="params">
  228. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  229. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  230. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated housearrest_client_t upon successful return.</td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when client is NULL, or an HOUSE_ARREST_E_* error code otherwise. </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="ac05b9c75d4cf605cf3b6b51478a49a36"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_client_start_service </td>
  243. <td>(</td>
  244. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  245. <td class="paramname"><em>device</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> *&#160;</td>
  251. <td class="paramname"><em>client</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype">const char *&#160;</td>
  257. <td class="paramname"><em>label</em>&#160;</td>
  258. </tr>
  259. <tr>
  260. <td></td>
  261. <td>)</td>
  262. <td></td><td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Starts a new house_arrest service on the specified device and connects to it. </p>
  267. <dl class="params"><dt>Parameters</dt><dd>
  268. <table class="params">
  269. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  270. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated house_arrest_client_t upon successful return. Must be freed using <a class="el" href="house__arrest_8h.html#ab48e57565d1e5ca52351a3ebc24b73a8" title="Disconnects an house_arrest client from the device and frees up the house_arrest client data...">house_arrest_client_free()</a> after use. </td></tr>
  271. <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>
  272. </table>
  273. </dd>
  274. </dl>
  275. <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS on success, or an HOUSE_ARREST_E_* error code otherwise. </dd></dl>
  276. </div>
  277. </div>
  278. <a class="anchor" id="a81f22f46c2707f0a6fe7e59126c10e74"></a>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_get_result </td>
  284. <td>(</td>
  285. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a>&#160;</td>
  286. <td class="paramname"><em>client</em>, </td>
  287. </tr>
  288. <tr>
  289. <td class="paramkey"></td>
  290. <td></td>
  291. <td class="paramtype">plist_t *&#160;</td>
  292. <td class="paramname"><em>dict</em>&#160;</td>
  293. </tr>
  294. <tr>
  295. <td></td>
  296. <td>)</td>
  297. <td></td><td></td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Retrieves the result of a previously sent house_arrest_request_* request. </p>
  302. <dl class="params"><dt>Parameters</dt><dd>
  303. <table class="params">
  304. <tr><td class="paramname">client</td><td>The house_arrest client to use </td></tr>
  305. <tr><td class="paramname">dict</td><td>Pointer that will be set to a plist containing the result to the last performed operation. It holds a key 'Status' with the value 'Complete' on success or a key 'Error' with an error description as value. The caller is responsible for freeing the returned plist.</td></tr>
  306. </table>
  307. </dd>
  308. </dl>
  309. <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS if a result plist was retrieved, HOUSE_ARREST_E_INVALID_ARG if client is invalid, HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode, or HOUSE_ARREST_E_CONN_FAILED if a connection error occured. </dd></dl>
  310. </div>
  311. </div>
  312. <a class="anchor" id="a0442d85e903b4784c6344d2e71507dc3"></a>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_send_command </td>
  318. <td>(</td>
  319. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a>&#160;</td>
  320. <td class="paramname"><em>client</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">const char *&#160;</td>
  326. <td class="paramname"><em>command</em>, </td>
  327. </tr>
  328. <tr>
  329. <td class="paramkey"></td>
  330. <td></td>
  331. <td class="paramtype">const char *&#160;</td>
  332. <td class="paramname"><em>appid</em>&#160;</td>
  333. </tr>
  334. <tr>
  335. <td></td>
  336. <td>)</td>
  337. <td></td><td></td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <p>Send a command to the connected house_arrest service. </p>
  342. <p>Calls <a class="el" href="house__arrest_8h.html#ac8f8df58815b4ccc6c9a875f67d52463" title="Sends a generic request to the connected house_arrest service. ">house_arrest_send_request()</a> internally.</p>
  343. <dl class="params"><dt>Parameters</dt><dd>
  344. <table class="params">
  345. <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
  346. <tr><td class="paramname">command</td><td>The command to send. Currently, only VendContainer and VendDocuments are known. </td></tr>
  347. <tr><td class="paramname">appid</td><td>The application identifier to pass along with the .</td></tr>
  348. </table>
  349. </dd>
  350. </dl>
  351. <dl class="section note"><dt>Note</dt><dd>If this function returns HOUSE_ARREST_E_SUCCESS it does not mean that the command was successful. To check for success or failure you need to call <a class="el" href="house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request. ">house_arrest_get_result()</a>. </dd></dl>
  352. <dl class="section see"><dt>See also</dt><dd><a class="el" href="house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request. ">house_arrest_get_result</a></dd></dl>
  353. <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS if the command was successfully sent, HOUSE_ARREST_E_INVALID_ARG if client, command, or appid is invalid, HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode, or HOUSE_ARREST_E_CONN_FAILED if a connection error occured. </dd></dl>
  354. </div>
  355. </div>
  356. <a class="anchor" id="ac8f8df58815b4ccc6c9a875f67d52463"></a>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_send_request </td>
  362. <td>(</td>
  363. <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a>&#160;</td>
  364. <td class="paramname"><em>client</em>, </td>
  365. </tr>
  366. <tr>
  367. <td class="paramkey"></td>
  368. <td></td>
  369. <td class="paramtype">plist_t&#160;</td>
  370. <td class="paramname"><em>dict</em>&#160;</td>
  371. </tr>
  372. <tr>
  373. <td></td>
  374. <td>)</td>
  375. <td></td><td></td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. <p>Sends a generic request to the connected house_arrest service. </p>
  380. <dl class="params"><dt>Parameters</dt><dd>
  381. <table class="params">
  382. <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
  383. <tr><td class="paramname">dict</td><td>The request to send as a plist of type PLIST_DICT.</td></tr>
  384. </table>
  385. </dd>
  386. </dl>
  387. <dl class="section note"><dt>Note</dt><dd>If this function returns HOUSE_ARREST_E_SUCCESS it does not mean that the request was successful. To check for success or failure you need to call <a class="el" href="house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request. ">house_arrest_get_result()</a>. </dd></dl>
  388. <dl class="section see"><dt>See also</dt><dd><a class="el" href="house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request. ">house_arrest_get_result</a></dd></dl>
  389. <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS if the request was successfully sent, HOUSE_ARREST_E_INVALID_ARG if client or dict is invalid, HOUSE_ARREST_E_PLIST_ERROR if dict is not a plist of type PLIST_DICT, HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode, or HOUSE_ARREST_E_CONN_FAILED if a connection error occured. </dd></dl>
  390. </div>
  391. </div>
  392. </div><!-- contents -->
  393. <!-- start footer part -->
  394. <hr class="footer"/><address class="footer"><small>
  395. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  396. <img class="footer" src="doxygen.png" alt="doxygen"/>
  397. </a> 1.8.8
  398. </small></address>
  399. </body>
  400. </html>