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">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
<title>libimobiledevice: libimobiledevice/misagent.h File Reference</title>
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15
<table cellspacing="0" cellpadding="0">
17
<tr style="height: 56px;">
18
<td style="padding-left: 0.5em;">
19
<div id="projectname">libimobiledevice
20
 <span id="projectnumber">1.1.5</span>
27
<!-- end header part -->
28
<!-- Generated by Doxygen 1.8.1 -->
29
<div id="navrow1" class="tabs">
31
<li><a href="index.html"><span>Main Page</span></a></li>
32
<li><a href="annotated.html"><span>Data Structures</span></a></li>
33
<li class="current"><a href="files.html"><span>Files</span></a></li>
36
<div id="navrow2" class="tabs2">
38
<li><a href="files.html"><span>File List</span></a></li>
39
<li><a href="globals.html"><span>Globals</span></a></li>
42
<div id="nav-path" class="navpath">
44
<li class="navelem"><a class="el" href="dir_0839347dbfd1d6806a2d090799a179ba.html">libimobiledevice</a></li> </ul>
49
<a href="#typedef-members">Typedefs</a> |
50
<a href="#func-members">Functions</a> </div>
51
<div class="headertitle">
52
<div class="title">misagent.h File Reference</div> </div>
54
<div class="contents">
56
<p>Manage provisioning profiles.
57
<a href="#details">More...</a></p>
58
<table class="memberdecls">
59
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
60
Typedefs</h2></td></tr>
61
<tr class="memitem:a2db9d48e48b8fd4cf10bbe8ce4cca375"><td class="memItemLeft" align="right" valign="top">typedef int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a></td></tr>
62
<tr class="memdesc:a2db9d48e48b8fd4cf10bbe8ce4cca375"><td class="mdescLeft"> </td><td class="mdescRight">Represents an error code. <a href="#a2db9d48e48b8fd4cf10bbe8ce4cca375"></a><br/></td></tr>
63
<tr class="memitem:a047e902df0f0760c7709d048ba9d1d46"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structmisagent__client__private.html">misagent_client_private</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a></td></tr>
64
<tr class="memdesc:a047e902df0f0760c7709d048ba9d1d46"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a047e902df0f0760c7709d048ba9d1d46"></a><br/></td></tr>
65
</table><table class="memberdecls">
66
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
67
Functions</h2></td></tr>
68
<tr class="memitem:a86f5601047ea079e1159313c6c5f450c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a86f5601047ea079e1159313c6c5f450c">misagent_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> *client)</td></tr>
69
<tr class="memdesc:a86f5601047ea079e1159313c6c5f450c"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the misagent service on the specified device. <a href="#a86f5601047ea079e1159313c6c5f450c"></a><br/></td></tr>
70
<tr class="memitem:a16553613c2e3d3305e6e601d8cd06033"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a16553613c2e3d3305e6e601d8cd06033">misagent_client_free</a> (<a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> client)</td></tr>
71
<tr class="memdesc:a16553613c2e3d3305e6e601d8cd06033"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects an misagent client from the device and frees up the misagent client data. <a href="#a16553613c2e3d3305e6e601d8cd06033"></a><br/></td></tr>
72
<tr class="memitem:ade5a61ff0d75ba56523d210669a7cfc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#ade5a61ff0d75ba56523d210669a7cfc1">misagent_install</a> (<a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> client, plist_t profile)</td></tr>
73
<tr class="memdesc:ade5a61ff0d75ba56523d210669a7cfc1"><td class="mdescLeft"> </td><td class="mdescRight">Installs the given provisioning profile. <a href="#ade5a61ff0d75ba56523d210669a7cfc1"></a><br/></td></tr>
74
<tr class="memitem:a6271ff3ac051b448c4a22d3809239b04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a6271ff3ac051b448c4a22d3809239b04">misagent_copy</a> (<a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> client, plist_t *profiles)</td></tr>
75
<tr class="memdesc:a6271ff3ac051b448c4a22d3809239b04"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves an array of all installed provisioning profiles. <a href="#a6271ff3ac051b448c4a22d3809239b04"></a><br/></td></tr>
76
<tr class="memitem:ad74d72e1494a34b10ba6dc037387f8e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#ad74d72e1494a34b10ba6dc037387f8e5">misagent_remove</a> (<a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> client, const char *profileID)</td></tr>
77
<tr class="memdesc:ad74d72e1494a34b10ba6dc037387f8e5"><td class="mdescLeft"> </td><td class="mdescRight">Removes a given provisioning profile. <a href="#ad74d72e1494a34b10ba6dc037387f8e5"></a><br/></td></tr>
78
<tr class="memitem:a8b7919f920d90dece6b43dede5e4af25"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a8b7919f920d90dece6b43dede5e4af25">misagent_get_status_code</a> (<a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> client)</td></tr>
79
<tr class="memdesc:a8b7919f920d90dece6b43dede5e4af25"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the status code from the last operation. <a href="#a8b7919f920d90dece6b43dede5e4af25"></a><br/></td></tr>
80
</table><table class="memberdecls">
81
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
82
Error Codes</h2></td></tr>
83
<tr class="memitem:a16db7ceb0311e670c081a80d328007eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16db7ceb0311e670c081a80d328007eb"></a>
84
#define </td><td class="memItemRight" valign="bottom"><b>MISAGENT_E_SUCCESS</b>   0</td></tr>
85
<tr class="memitem:aa1fe236f717560704ac131377993e7a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1fe236f717560704ac131377993e7a0"></a>
86
#define </td><td class="memItemRight" valign="bottom"><b>MISAGENT_E_INVALID_ARG</b>   -1</td></tr>
87
<tr class="memitem:aab1a19f337a172c599264dc1c5b05ab5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab1a19f337a172c599264dc1c5b05ab5"></a>
88
#define </td><td class="memItemRight" valign="bottom"><b>MISAGENT_E_PLIST_ERROR</b>   -2</td></tr>
89
<tr class="memitem:a936e09ec48669eab6a63199572835f63"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a936e09ec48669eab6a63199572835f63"></a>
90
#define </td><td class="memItemRight" valign="bottom"><b>MISAGENT_E_CONN_FAILED</b>   -3</td></tr>
91
<tr class="memitem:afcb01cef6acc5be26522cffc4f37fb04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcb01cef6acc5be26522cffc4f37fb04"></a>
92
#define </td><td class="memItemRight" valign="bottom"><b>MISAGENT_E_REQUEST_FAILED</b>   -4</td></tr>
93
<tr class="memitem:a8eb6231fc5da39d9d584be4444e9df0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8eb6231fc5da39d9d584be4444e9df0c"></a>
94
#define </td><td class="memItemRight" valign="bottom"><b>MISAGENT_E_UNKNOWN_ERROR</b>   -256</td></tr>
96
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
97
<div class="textblock"><p>Manage provisioning profiles. </p>
98
</div><hr/><h2>Typedef Documentation</h2>
99
<a class="anchor" id="a047e902df0f0760c7709d048ba9d1d46"></a>
100
<div class="memitem">
101
<div class="memproto">
102
<table class="memname">
104
<td class="memname">typedef <a class="el" href="structmisagent__client__private.html">misagent_client_private</a>* <a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a></td>
107
</div><div class="memdoc">
109
<p>The client handle. </p>
113
<a class="anchor" id="a2db9d48e48b8fd4cf10bbe8ce4cca375"></a>
114
<div class="memitem">
115
<div class="memproto">
116
<table class="memname">
118
<td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a></td>
121
</div><div class="memdoc">
123
<p>Represents an error code. </p>
127
<hr/><h2>Function Documentation</h2>
128
<a class="anchor" id="a16553613c2e3d3305e6e601d8cd06033"></a>
129
<div class="memitem">
130
<div class="memproto">
131
<table class="memname">
133
<td class="memname"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> misagent_client_free </td>
135
<td class="paramtype"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> </td>
136
<td class="paramname"><em>client</em></td><td>)</td>
140
</div><div class="memdoc">
142
<p>Disconnects an misagent client from the device and frees up the misagent client data. </p>
143
<dl class="params"><dt>Parameters:</dt><dd>
144
<table class="params">
145
<tr><td class="paramname">client</td><td>The misagent client to disconnect and free.</td></tr>
149
<dl class="section return"><dt>Returns:</dt><dd>MISAGENT_E_SUCCESS on success, MISAGENT_E_INVALID_ARG when client is NULL, or an MISAGENT_E_* error code otherwise. </dd></dl>
153
<a class="anchor" id="a86f5601047ea079e1159313c6c5f450c"></a>
154
<div class="memitem">
155
<div class="memproto">
156
<table class="memname">
158
<td class="memname"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> misagent_client_new </td>
160
<td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
161
<td class="paramname"><em>device</em>, </td>
164
<td class="paramkey"></td>
166
<td class="paramtype">lockdownd_service_descriptor_t </td>
167
<td class="paramname"><em>service</em>, </td>
170
<td class="paramkey"></td>
172
<td class="paramtype"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> * </td>
173
<td class="paramname"><em>client</em> </td>
181
</div><div class="memdoc">
183
<p>Connects to the misagent service on the specified device. </p>
184
<dl class="params"><dt>Parameters:</dt><dd>
185
<table class="params">
186
<tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
187
<tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
188
<tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated misagent_client_t upon successful return.</td></tr>
192
<dl class="section return"><dt>Returns:</dt><dd>MISAGENT_E_SUCCESS on success, MISAGENT_E_INVALID_ARG when client is NULL, or an MISAGENT_E_* error code otherwise. </dd></dl>
196
<a class="anchor" id="a6271ff3ac051b448c4a22d3809239b04"></a>
197
<div class="memitem">
198
<div class="memproto">
199
<table class="memname">
201
<td class="memname"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> misagent_copy </td>
203
<td class="paramtype"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> </td>
204
<td class="paramname"><em>client</em>, </td>
207
<td class="paramkey"></td>
209
<td class="paramtype">plist_t * </td>
210
<td class="paramname"><em>profiles</em> </td>
218
</div><div class="memdoc">
220
<p>Retrieves an array of all installed provisioning profiles. </p>
221
<dl class="params"><dt>Parameters:</dt><dd>
222
<table class="params">
223
<tr><td class="paramname">client</td><td>The connected misagent to use. </td></tr>
224
<tr><td class="paramname">profiles</td><td>Pointer to a plist_t that will be set to a PLIST_ARRAY if the function is successful.</td></tr>
228
<dl class="section return"><dt>Returns:</dt><dd>MISAGENT_E_SUCCESS on success, MISAGENT_E_INVALID_ARG when client is invalid, or an MISAGENT_E_* error code otherwise.</dd></dl>
229
<dl class="section note"><dt>Note:</dt><dd>If no provisioning profiles are installed on the device, this function still returns MISAGENT_E_SUCCESS and profiles will just point to an empty array. </dd></dl>
233
<a class="anchor" id="a8b7919f920d90dece6b43dede5e4af25"></a>
234
<div class="memitem">
235
<div class="memproto">
236
<table class="memname">
238
<td class="memname">int misagent_get_status_code </td>
240
<td class="paramtype"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> </td>
241
<td class="paramname"><em>client</em></td><td>)</td>
245
</div><div class="memdoc">
247
<p>Retrieves the status code from the last operation. </p>
248
<dl class="params"><dt>Parameters:</dt><dd>
249
<table class="params">
250
<tr><td class="paramname">client</td><td>The misagent to use.</td></tr>
254
<dl class="section return"><dt>Returns:</dt><dd>-1 if client is invalid, or the status code from the last operation </dd></dl>
258
<a class="anchor" id="ade5a61ff0d75ba56523d210669a7cfc1"></a>
259
<div class="memitem">
260
<div class="memproto">
261
<table class="memname">
263
<td class="memname"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> misagent_install </td>
265
<td class="paramtype"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> </td>
266
<td class="paramname"><em>client</em>, </td>
269
<td class="paramkey"></td>
271
<td class="paramtype">plist_t </td>
272
<td class="paramname"><em>profile</em> </td>
280
</div><div class="memdoc">
282
<p>Installs the given provisioning profile. </p>
283
<p>Only works with valid profiles.</p>
284
<dl class="params"><dt>Parameters:</dt><dd>
285
<table class="params">
286
<tr><td class="paramname">client</td><td>The connected misagent to use for installation </td></tr>
287
<tr><td class="paramname">profile</td><td>The valid provisioning profile to install. This has to be passed as a PLIST_DATA, otherwise the function will fail.</td></tr>
291
<dl class="section return"><dt>Returns:</dt><dd>MISAGENT_E_SUCCESS on success, MISAGENT_E_INVALID_ARG when client is invalid, or an MISAGENT_E_* error code otherwise. </dd></dl>
295
<a class="anchor" id="ad74d72e1494a34b10ba6dc037387f8e5"></a>
296
<div class="memitem">
297
<div class="memproto">
298
<table class="memname">
300
<td class="memname"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a2db9d48e48b8fd4cf10bbe8ce4cca375">misagent_error_t</a> misagent_remove </td>
302
<td class="paramtype"><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a047e902df0f0760c7709d048ba9d1d46">misagent_client_t</a> </td>
303
<td class="paramname"><em>client</em>, </td>
306
<td class="paramkey"></td>
308
<td class="paramtype">const char * </td>
309
<td class="paramname"><em>profileID</em> </td>
317
</div><div class="memdoc">
319
<p>Removes a given provisioning profile. </p>
320
<dl class="params"><dt>Parameters:</dt><dd>
321
<table class="params">
322
<tr><td class="paramname">client</td><td>The connected misagent to use. </td></tr>
323
<tr><td class="paramname">profileID</td><td>Identifier of the provisioning profile to remove. This is a UUID that can be obtained from the provisioning profile data. </td></tr>
327
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="include_2libimobiledevice_2misagent_8h.html#a6271ff3ac051b448c4a22d3809239b04" title="Retrieves an array of all installed provisioning profiles.">misagent_copy</a></dd></dl>
328
<dl class="section return"><dt>Returns:</dt><dd>MISAGENT_E_SUCCESS on success, MISAGENT_E_INVALID_ARG when client is invalid, or an MISAGENT_E_* error code otherwise. </dd></dl>
332
</div><!-- contents -->
333
<!-- start footer part -->
334
<hr class="footer"/><address class="footer"><small>
335
Generated by  <a href="http://www.doxygen.org/index.html">
336
<img class="footer" src="doxygen.png" alt="doxygen"/>