| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417 |
- <!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/house_arrest.h File Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">libimobiledevice
-  <span id="projectnumber">1.2.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.8 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#define-members">Macros</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">house_arrest.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Access app folders and their contents.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:a0acdbeac5a5d74e75eadf03c829abdbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0acdbeac5a5d74e75eadf03c829abdbb"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_SERVICE_NAME</b>   "com.apple.mobile.house_arrest"</td></tr>
- <tr class="separator:a0acdbeac5a5d74e75eadf03c829abdbb"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:aba8ce3e4a71343138317a458e8066e94"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba8ce3e4a71343138317a458e8066e94"></a>
- typedef struct <br class="typebreak" />
- house_arrest_client_private </td><td class="memItemRight" valign="bottom"><b>house_arrest_client_private</b></td></tr>
- <tr class="separator:aba8ce3e4a71343138317a458e8066e94"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a66fc0910d9ae304fe23848f0547d3baf"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
- house_arrest_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a></td></tr>
- <tr class="memdesc:a66fc0910d9ae304fe23848f0547d3baf"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a66fc0910d9ae304fe23848f0547d3baf">More...</a><br /></td></tr>
- <tr class="separator:a66fc0910d9ae304fe23848f0547d3baf"><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:a6afca9f79e3a3af7d52db5bf2e3125d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6afca9f79e3a3af7d52db5bf2e3125d1"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> { <br />
-   <b>HOUSE_ARREST_E_SUCCESS</b> = 0,
- <br />
-   <b>HOUSE_ARREST_E_INVALID_ARG</b> = -1,
- <br />
-   <b>HOUSE_ARREST_E_PLIST_ERROR</b> = -2,
- <br />
-   <b>HOUSE_ARREST_E_CONN_FAILED</b> = -3,
- <br />
-   <b>HOUSE_ARREST_E_INVALID_MODE</b> = -4,
- <br />
-   <b>HOUSE_ARREST_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a6afca9f79e3a3af7d52db5bf2e3125d1"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a6afca9f79e3a3af7d52db5bf2e3125d1"><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:a9d5feb409ee90b6763153f73f0899920"><td class="memItemLeft" align="right" valign="top"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> </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>
- <tr class="memdesc:a9d5feb409ee90b6763153f73f0899920"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the house_arrest service on the specified device. <a href="#a9d5feb409ee90b6763153f73f0899920">More...</a><br /></td></tr>
- <tr class="separator:a9d5feb409ee90b6763153f73f0899920"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ac05b9c75d4cf605cf3b6b51478a49a36"><td class="mdescLeft"> </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>
- <tr class="separator:ac05b9c75d4cf605cf3b6b51478a49a36"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ab48e57565d1e5ca52351a3ebc24b73a8"><td class="mdescLeft"> </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>
- <tr class="separator:ab48e57565d1e5ca52351a3ebc24b73a8"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ac8f8df58815b4ccc6c9a875f67d52463"><td class="mdescLeft"> </td><td class="mdescRight">Sends a generic request to the connected house_arrest service. <a href="#ac8f8df58815b4ccc6c9a875f67d52463">More...</a><br /></td></tr>
- <tr class="separator:ac8f8df58815b4ccc6c9a875f67d52463"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a0442d85e903b4784c6344d2e71507dc3"><td class="mdescLeft"> </td><td class="mdescRight">Send a command to the connected house_arrest service. <a href="#a0442d85e903b4784c6344d2e71507dc3">More...</a><br /></td></tr>
- <tr class="separator:a0442d85e903b4784c6344d2e71507dc3"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a81f22f46c2707f0a6fe7e59126c10e74"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the result of a previously sent house_arrest_request_* request. <a href="#a81f22f46c2707f0a6fe7e59126c10e74">More...</a><br /></td></tr>
- <tr class="separator:a81f22f46c2707f0a6fe7e59126c10e74"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a46e202a2bcfa7ef82e362f3bc98a3f49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </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>
- <tr class="memdesc:a46e202a2bcfa7ef82e362f3bc98a3f49"><td class="mdescLeft"> </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>
- <tr class="separator:a46e202a2bcfa7ef82e362f3bc98a3f49"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Access app folders and their contents. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a66fc0910d9ae304fe23848f0547d3baf"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef house_arrest_client_private* <a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_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="a46e202a2bcfa7ef82e362f3bc98a3f49"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_client_new_from_house_arrest_client </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> * </td>
- <td class="paramname"><em>afc_client</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- <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>
- </div>
- </div>
- <a class="anchor" id="ab48e57565d1e5ca52351a3ebc24b73a8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disconnects an house_arrest client from the device and frees up the house_arrest client data. </p>
- <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'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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The house_arrest client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a9d5feb409ee90b6763153f73f0899920"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_client_new </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">lockdownd_service_descriptor_t </td>
- <td class="paramname"><em>service</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> * </td>
- <td class="paramname"><em>client</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connects to the house_arrest service on the specified device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated housearrest_client_t upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ac05b9c75d4cf605cf3b6b51478a49a36"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_client_start_service </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a> * </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>label</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts a new house_arrest service on the specified device and connects to it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated 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>
- <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>HOUSE_ARREST_E_SUCCESS on success, or an HOUSE_ARREST_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a81f22f46c2707f0a6fe7e59126c10e74"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_get_result </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_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>dict</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Retrieves the result of a previously sent house_arrest_request_* request. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The house_arrest client to use </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a0442d85e903b4784c6344d2e71507dc3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_send_command </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_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>command</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>appid</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a command to the connected house_arrest service. </p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
- <tr><td class="paramname">command</td><td>The command to send. Currently, only VendContainer and VendDocuments are known. </td></tr>
- <tr><td class="paramname">appid</td><td>The application identifier to pass along with the .</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <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>
- <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>
- </div>
- </div>
- <a class="anchor" id="ac8f8df58815b4ccc6c9a875f67d52463"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="house__arrest_8h.html#a6afca9f79e3a3af7d52db5bf2e3125d1">house_arrest_error_t</a> house_arrest_send_request </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_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>dict</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a generic request to the connected house_arrest service. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
- <tr><td class="paramname">dict</td><td>The request to send as a plist of type PLIST_DICT.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <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>
- <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>
- </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>
|