← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libimobiledevice/trusty

« back to all changes in this revision

Viewing changes to docs/html/include_2libimobiledevice_2house__arrest_8h.html

  • Committer: Package Import Robot
  • Author(s): Julien Lavergne
  • Date: 2011-09-16 00:01:44 UTC
  • mfrom: (1.1.8 upstream) (6.1.6 experimental)
  • Revision ID: package-import@ubuntu.com-20110916000144-13otcnnzl0rapoly
Tags: 1.1.1-2
http://bugs.debian.org/631821
* Upload to unstable, most of the API should be stable now.
* debian/patches/
 - 02-add-missing-linking.patch: Refresh
 - 03_ac_pkg_swig_m4_fixed.patch: Fix building python bindings. Thanks
   Sebastian Ramacher for the patch (Closes: #631821).
 - 04_libplist_DSO_linking.patch: Add libplist to LDFLAGS.
* debian/control:
 - Build-depends on dh-autoreconf for 03_ac_pkg_swig_m4_fixed.patch.
 - Add DM-Upload-Allowed: yes
* debian/rules:
 - Run dh --with autoreconf for 03_ac_pkg_swig_m4_fixed.patch.
 - Remove .la files for python bindings also.
 - Remove .a files from python bindings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/include_2libimobiledevice_2house__arrest_8h.html
 
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
<title>libimobiledevice: libimobiledevice/house_arrest.h File Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.3 -->
 
11
<div id="top">
 
12
<div id="titlearea">
 
13
<table cellspacing="0" cellpadding="0">
 
14
 <tbody>
 
15
 <tr style="height: 56px;">
 
16
  <td style="padding-left: 0.5em;">
 
17
   <div id="projectname">libimobiledevice&#160;<span id="projectnumber">1.1.1</span></div>
 
18
  </td>
 
19
 </tr>
 
20
 </tbody>
 
21
</table>
 
22
</div>
 
23
  <div id="navrow1" class="tabs">
 
24
    <ul class="tablist">
 
25
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
26
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
 
27
      <li class="current"><a href="files.html"><span>Files</span></a></li>
 
28
    </ul>
 
29
  </div>
 
30
  <div id="navrow2" class="tabs2">
 
31
    <ul class="tablist">
 
32
      <li><a href="files.html"><span>File&#160;List</span></a></li>
 
33
      <li><a href="globals.html"><span>Globals</span></a></li>
 
34
    </ul>
 
35
  </div>
 
36
</div>
 
37
<div class="header">
 
38
  <div class="summary">
 
39
<a href="#typedef-members">Typedefs</a> &#124;
 
40
<a href="#func-members">Functions</a>  </div>
 
41
  <div class="headertitle">
 
42
<h1>libimobiledevice/house_arrest.h File Reference</h1>  </div>
 
43
</div>
 
44
<div class="contents">
 
45
 
 
46
<p>Access AppStore application folders and their contents.  
 
47
<a href="#_details">More...</a></p>
 
48
<table class="memberdecls">
 
49
<tr><td colspan="2"><h2><a name="typedef-members"></a>
 
50
Typedefs</h2></td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a></td></tr>
 
52
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an error code.  <a href="#aa64b83316bd9dbf06bde006600ea9b67"></a><br/></td></tr>
 
53
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
 
54
<a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_private</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a66fc0910d9ae304fe23848f0547d3baf">house_arrest_client_t</a></td></tr>
 
55
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle.  <a href="#a66fc0910d9ae304fe23848f0547d3baf"></a><br/></td></tr>
 
56
<tr><td colspan="2"><h2><a name="func-members"></a>
 
57
Functions</h2></td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#af1daec36c5974b22beaae90de6e2c9b9">house_arrest_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> *client)</td></tr>
 
59
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the house_arrest service on the specified device.  <a href="#af1daec36c5974b22beaae90de6e2c9b9"></a><br/></td></tr>
 
60
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#ab48e57565d1e5ca52351a3ebc24b73a8">house_arrest_client_free</a> (<a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> client)</td></tr>
 
61
<tr><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"></a><br/></td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#ac8f8df58815b4ccc6c9a875f67d52463">house_arrest_send_request</a> (<a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> client, plist_t dict)</td></tr>
 
63
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a generic request to the connected house_arrest service.  <a href="#ac8f8df58815b4ccc6c9a875f67d52463"></a><br/></td></tr>
 
64
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a0442d85e903b4784c6344d2e71507dc3">house_arrest_send_command</a> (<a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> client, const char *command, const char *appid)</td></tr>
 
65
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the connected house_arrest service.  <a href="#a0442d85e903b4784c6344d2e71507dc3"></a><br/></td></tr>
 
66
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74">house_arrest_get_result</a> (<a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> client, plist_t *dict)</td></tr>
 
67
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the result of a previously sent house_arrest_request_* request.  <a href="#a81f22f46c2707f0a6fe7e59126c10e74"></a><br/></td></tr>
 
68
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2afc_8h.html#afa46b7e1ac472a5589d85d6a6a7104fb">afc_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a46e202a2bcfa7ef82e362f3bc98a3f49">afc_client_new_from_house_arrest_client</a> (<a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> client, <a class="el" href="structafc__client__private.html">afc_client_t</a> *afc_client)</td></tr>
 
69
<tr><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"></a><br/></td></tr>
 
70
<tr><td colspan="2"><h2><a name="member-group"></a>
 
71
Error Codes</h2></td></tr>
 
72
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e21ee175bbabdab4e5fddae4f365856"></a><!-- doxytag: member="include/libimobiledevice/house_arrest.h::HOUSE_ARREST_E_SUCCESS" ref="a6e21ee175bbabdab4e5fddae4f365856" args="" -->
 
73
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_E_SUCCESS</b>&#160;&#160;&#160;0</td></tr>
 
74
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6d833307249ce0b58befc7065b3bb5a"></a><!-- doxytag: member="include/libimobiledevice/house_arrest.h::HOUSE_ARREST_E_INVALID_ARG" ref="af6d833307249ce0b58befc7065b3bb5a" args="" -->
 
75
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_E_INVALID_ARG</b>&#160;&#160;&#160;-1</td></tr>
 
76
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a389a69d900d349c7121d4b212d383019"></a><!-- doxytag: member="include/libimobiledevice/house_arrest.h::HOUSE_ARREST_E_PLIST_ERROR" ref="a389a69d900d349c7121d4b212d383019" args="" -->
 
77
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_E_PLIST_ERROR</b>&#160;&#160;&#160;-2</td></tr>
 
78
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79033363fb5866c59cdcb89747b22b6c"></a><!-- doxytag: member="include/libimobiledevice/house_arrest.h::HOUSE_ARREST_E_CONN_FAILED" ref="a79033363fb5866c59cdcb89747b22b6c" args="" -->
 
79
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_E_CONN_FAILED</b>&#160;&#160;&#160;-3</td></tr>
 
80
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d74c36eeb8b1b77abfd995c88ae5844"></a><!-- doxytag: member="include/libimobiledevice/house_arrest.h::HOUSE_ARREST_E_INVALID_MODE" ref="a9d74c36eeb8b1b77abfd995c88ae5844" args="" -->
 
81
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_E_INVALID_MODE</b>&#160;&#160;&#160;-4</td></tr>
 
82
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae39fd85a5511fe0d79384a7526d83de4"></a><!-- doxytag: member="include/libimobiledevice/house_arrest.h::HOUSE_ARREST_E_UNKNOWN_ERROR" ref="ae39fd85a5511fe0d79384a7526d83de4" args="" -->
 
83
#define&#160;</td><td class="memItemRight" valign="bottom"><b>HOUSE_ARREST_E_UNKNOWN_ERROR</b>&#160;&#160;&#160;-256</td></tr>
 
84
</table>
 
85
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
86
<div class="textblock"><p>Access AppStore application folders and their contents. </p>
 
87
</div><hr/><h2>Typedef Documentation</h2>
 
88
<a class="anchor" id="a66fc0910d9ae304fe23848f0547d3baf"></a><!-- doxytag: member="house_arrest.h::house_arrest_client_t" ref="a66fc0910d9ae304fe23848f0547d3baf" args="" -->
 
89
<div class="memitem">
 
90
<div class="memproto">
 
91
      <table class="memname">
 
92
        <tr>
 
93
          <td class="memname">typedef <a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_private</a>* <a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a></td>
 
94
        </tr>
 
95
      </table>
 
96
</div>
 
97
<div class="memdoc">
 
98
 
 
99
<p>The client handle. </p>
 
100
 
 
101
</div>
 
102
</div>
 
103
<a class="anchor" id="aa64b83316bd9dbf06bde006600ea9b67"></a><!-- doxytag: member="house_arrest.h::house_arrest_error_t" ref="aa64b83316bd9dbf06bde006600ea9b67" args="" -->
 
104
<div class="memitem">
 
105
<div class="memproto">
 
106
      <table class="memname">
 
107
        <tr>
 
108
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a></td>
 
109
        </tr>
 
110
      </table>
 
111
</div>
 
112
<div class="memdoc">
 
113
 
 
114
<p>Represents an error code. </p>
 
115
 
 
116
</div>
 
117
</div>
 
118
<hr/><h2>Function Documentation</h2>
 
119
<a class="anchor" id="a46e202a2bcfa7ef82e362f3bc98a3f49"></a><!-- doxytag: member="house_arrest.h::afc_client_new_from_house_arrest_client" ref="a46e202a2bcfa7ef82e362f3bc98a3f49" args="(house_arrest_client_t client, afc_client_t *afc_client)" -->
 
120
<div class="memitem">
 
121
<div class="memproto">
 
122
      <table class="memname">
 
123
        <tr>
 
124
          <td class="memname"><a class="el" href="include_2libimobiledevice_2afc_8h.html#afa46b7e1ac472a5589d85d6a6a7104fb">afc_error_t</a> afc_client_new_from_house_arrest_client </td>
 
125
          <td>(</td>
 
126
          <td class="paramtype"><a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a>&#160;</td>
 
127
          <td class="paramname"><em>client</em>, </td>
 
128
        </tr>
 
129
        <tr>
 
130
          <td class="paramkey"></td>
 
131
          <td></td>
 
132
          <td class="paramtype"><a class="el" href="structafc__client__private.html">afc_client_t</a> *&#160;</td>
 
133
          <td class="paramname"><em>afc_client</em>&#160;</td>
 
134
        </tr>
 
135
        <tr>
 
136
          <td></td>
 
137
          <td>)</td>
 
138
          <td></td><td></td>
 
139
        </tr>
 
140
      </table>
 
141
</div>
 
142
<div class="memdoc">
 
143
 
 
144
<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>
 
145
<dl><dt><b>Parameters:</b></dt><dd>
 
146
  <table class="params">
 
147
    <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
 
148
    <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>
 
149
  </table>
 
150
  </dd>
 
151
</dl>
 
152
<dl class="note"><dt><b>Note:</b></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="include_2libimobiledevice_2house__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="include_2libimobiledevice_2house__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>
 
153
<dl class="return"><dt><b>Returns:</b></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 <a class="el" href="include_2libimobiledevice_2afc_8h.html#ace20f84f3ef1e63c8731512cfa3ec4ec" title="Makes a connection to the AFC service on the device using the given connection.">afc_client_new_from_connection()</a>. </dd></dl>
 
154
 
 
155
</div>
 
156
</div>
 
157
<a class="anchor" id="ab48e57565d1e5ca52351a3ebc24b73a8"></a><!-- doxytag: member="house_arrest.h::house_arrest_client_free" ref="ab48e57565d1e5ca52351a3ebc24b73a8" args="(house_arrest_client_t client)" -->
 
158
<div class="memitem">
 
159
<div class="memproto">
 
160
      <table class="memname">
 
161
        <tr>
 
162
          <td class="memname"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a> house_arrest_client_free </td>
 
163
          <td>(</td>
 
164
          <td class="paramtype"><a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a>&#160;</td>
 
165
          <td class="paramname"><em>client</em></td><td>)</td>
 
166
          <td></td>
 
167
        </tr>
 
168
      </table>
 
169
</div>
 
170
<div class="memdoc">
 
171
 
 
172
<p>Disconnects an house_arrest client from the device and frees up the house_arrest client data. </p>
 
173
<dl class="note"><dt><b>Note:</b></dt><dd>After using <a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a46e202a2bcfa7ef82e362f3bc98a3f49" title="Creates an AFC client using the given house_arrest client&#39;s connection allowing file access to a ...">afc_client_new_from_house_arrest_client()</a>, make sure you call <a class="el" href="include_2libimobiledevice_2afc_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>
 
174
<dl><dt><b>Parameters:</b></dt><dd>
 
175
  <table class="params">
 
176
    <tr><td class="paramname">client</td><td>The house_arrest client to disconnect and free.</td></tr>
 
177
  </table>
 
178
  </dd>
 
179
</dl>
 
180
<dl class="return"><dt><b>Returns:</b></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>
 
181
 
 
182
</div>
 
183
</div>
 
184
<a class="anchor" id="af1daec36c5974b22beaae90de6e2c9b9"></a><!-- doxytag: member="house_arrest.h::house_arrest_client_new" ref="af1daec36c5974b22beaae90de6e2c9b9" args="(idevice_t device, uint16_t port, house_arrest_client_t *client)" -->
 
185
<div class="memitem">
 
186
<div class="memproto">
 
187
      <table class="memname">
 
188
        <tr>
 
189
          <td class="memname"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a> house_arrest_client_new </td>
 
190
          <td>(</td>
 
191
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&#160;</td>
 
192
          <td class="paramname"><em>device</em>, </td>
 
193
        </tr>
 
194
        <tr>
 
195
          <td class="paramkey"></td>
 
196
          <td></td>
 
197
          <td class="paramtype">uint16_t&#160;</td>
 
198
          <td class="paramname"><em>port</em>, </td>
 
199
        </tr>
 
200
        <tr>
 
201
          <td class="paramkey"></td>
 
202
          <td></td>
 
203
          <td class="paramtype"><a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a> *&#160;</td>
 
204
          <td class="paramname"><em>client</em>&#160;</td>
 
205
        </tr>
 
206
        <tr>
 
207
          <td></td>
 
208
          <td>)</td>
 
209
          <td></td><td></td>
 
210
        </tr>
 
211
      </table>
 
212
</div>
 
213
<div class="memdoc">
 
214
 
 
215
<p>Connects to the house_arrest service on the specified device. </p>
 
216
<dl><dt><b>Parameters:</b></dt><dd>
 
217
  <table class="params">
 
218
    <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
 
219
    <tr><td class="paramname">port</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
 
220
    <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated housearrest_client_t upon successful return.</td></tr>
 
221
  </table>
 
222
  </dd>
 
223
</dl>
 
224
<dl class="return"><dt><b>Returns:</b></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>
 
225
 
 
226
</div>
 
227
</div>
 
228
<a class="anchor" id="a81f22f46c2707f0a6fe7e59126c10e74"></a><!-- doxytag: member="house_arrest.h::house_arrest_get_result" ref="a81f22f46c2707f0a6fe7e59126c10e74" args="(house_arrest_client_t client, plist_t *dict)" -->
 
229
<div class="memitem">
 
230
<div class="memproto">
 
231
      <table class="memname">
 
232
        <tr>
 
233
          <td class="memname"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a> house_arrest_get_result </td>
 
234
          <td>(</td>
 
235
          <td class="paramtype"><a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a>&#160;</td>
 
236
          <td class="paramname"><em>client</em>, </td>
 
237
        </tr>
 
238
        <tr>
 
239
          <td class="paramkey"></td>
 
240
          <td></td>
 
241
          <td class="paramtype">plist_t *&#160;</td>
 
242
          <td class="paramname"><em>dict</em>&#160;</td>
 
243
        </tr>
 
244
        <tr>
 
245
          <td></td>
 
246
          <td>)</td>
 
247
          <td></td><td></td>
 
248
        </tr>
 
249
      </table>
 
250
</div>
 
251
<div class="memdoc">
 
252
 
 
253
<p>Retrieves the result of a previously sent house_arrest_request_* request. </p>
 
254
<dl><dt><b>Parameters:</b></dt><dd>
 
255
  <table class="params">
 
256
    <tr><td class="paramname">client</td><td>The house_arrest client to use </td></tr>
 
257
    <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>
 
258
  </table>
 
259
  </dd>
 
260
</dl>
 
261
<dl class="return"><dt><b>Returns:</b></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>
 
262
 
 
263
</div>
 
264
</div>
 
265
<a class="anchor" id="a0442d85e903b4784c6344d2e71507dc3"></a><!-- doxytag: member="house_arrest.h::house_arrest_send_command" ref="a0442d85e903b4784c6344d2e71507dc3" args="(house_arrest_client_t client, const char *command, const char *appid)" -->
 
266
<div class="memitem">
 
267
<div class="memproto">
 
268
      <table class="memname">
 
269
        <tr>
 
270
          <td class="memname"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a> house_arrest_send_command </td>
 
271
          <td>(</td>
 
272
          <td class="paramtype"><a class="el" href="structhouse__arrest__client__private.html">house_arrest_client_t</a>&#160;</td>
 
273
          <td class="paramname"><em>client</em>, </td>
 
274
        </tr>
 
275
        <tr>
 
276
          <td class="paramkey"></td>
 
277
          <td></td>
 
278
          <td class="paramtype">const char *&#160;</td>
 
279
          <td class="paramname"><em>command</em>, </td>
 
280
        </tr>
 
281
        <tr>
 
282
          <td class="paramkey"></td>
 
283
          <td></td>
 
284
          <td class="paramtype">const char *&#160;</td>
 
285
          <td class="paramname"><em>appid</em>&#160;</td>
 
286
        </tr>
 
287
        <tr>
 
288
          <td></td>
 
289
          <td>)</td>
 
290
          <td></td><td></td>
 
291
        </tr>
 
292
      </table>
 
293
</div>
 
294
<div class="memdoc">
 
295
 
 
296
<p>Send a command to the connected house_arrest service. </p>
 
297
<p>Calls <a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#ac8f8df58815b4ccc6c9a875f67d52463" title="Sends a generic request to the connected house_arrest service.">house_arrest_send_request()</a> internally.</p>
 
298
<dl><dt><b>Parameters:</b></dt><dd>
 
299
  <table class="params">
 
300
    <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
 
301
    <tr><td class="paramname">command</td><td>The command to send. Currently, only VendContainer and VendDocuments are known. </td></tr>
 
302
    <tr><td class="paramname">appid</td><td>The application identifier to pass along with the .</td></tr>
 
303
  </table>
 
304
  </dd>
 
305
</dl>
 
306
<dl class="note"><dt><b>Note:</b></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="include_2libimobiledevice_2house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request.">house_arrest_get_result()</a>. </dd></dl>
 
307
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request.">house_arrest_get_result</a></dd></dl>
 
308
<dl class="return"><dt><b>Returns:</b></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>
 
309
 
 
310
</div>
 
311
</div>
 
312
<a class="anchor" id="ac8f8df58815b4ccc6c9a875f67d52463"></a><!-- doxytag: member="house_arrest.h::house_arrest_send_request" ref="ac8f8df58815b4ccc6c9a875f67d52463" args="(house_arrest_client_t client, plist_t dict)" -->
 
313
<div class="memitem">
 
314
<div class="memproto">
 
315
      <table class="memname">
 
316
        <tr>
 
317
          <td class="memname"><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#aa64b83316bd9dbf06bde006600ea9b67">house_arrest_error_t</a> house_arrest_send_request </td>
 
318
          <td>(</td>
 
319
          <td class="paramtype"><a class="el" href="structhouse__arrest__client__private.html">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">plist_t&#160;</td>
 
326
          <td class="paramname"><em>dict</em>&#160;</td>
 
327
        </tr>
 
328
        <tr>
 
329
          <td></td>
 
330
          <td>)</td>
 
331
          <td></td><td></td>
 
332
        </tr>
 
333
      </table>
 
334
</div>
 
335
<div class="memdoc">
 
336
 
 
337
<p>Sends a generic request to the connected house_arrest service. </p>
 
338
<dl><dt><b>Parameters:</b></dt><dd>
 
339
  <table class="params">
 
340
    <tr><td class="paramname">client</td><td>The house_arrest client to use. </td></tr>
 
341
    <tr><td class="paramname">dict</td><td>The request to send as a plist of type PLIST_DICT.</td></tr>
 
342
  </table>
 
343
  </dd>
 
344
</dl>
 
345
<dl class="note"><dt><b>Note:</b></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="include_2libimobiledevice_2house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request.">house_arrest_get_result()</a>. </dd></dl>
 
346
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="include_2libimobiledevice_2house__arrest_8h.html#a81f22f46c2707f0a6fe7e59126c10e74" title="Retrieves the result of a previously sent house_arrest_request_* request.">house_arrest_get_result</a></dd></dl>
 
347
<dl class="return"><dt><b>Returns:</b></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>
 
348
 
 
349
</div>
 
350
</div>
 
351
</div>
 
352
<hr class="footer"/><address class="footer"><small>Generated by&#160;
 
353
<a href="http://www.doxygen.org/index.html">
 
354
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
 
355
</body>
 
356
</html>