← Back to branch summary

~ubuntu-branches/ubuntu/quantal/libimobiledevice/quantal-updates

« back to all changes in this revision

Viewing changes to docs/html/include_2libimobiledevice_2restore_8h.html

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2010-12-19 00:11:04 UTC
  • mfrom: (2.1.7 experimental)
  • Revision ID: james.westby@ubuntu.com-20101219001104-minn5kkcw1die9c3
Tags: 1.1.0-1
* New upstream development release, API is considered unstable.
* debian/libimobiledevice1*, debian/rules, debian/control:
 - Bump SONAME for libimobiledevice library.
* debian/copyright:
 - Update copyright holders.
* debian/libimobiledevice2.symbols:
 - Update with new symbols.
* debian/ideviceenterrecovery.1:
 - Add new manpage.
* debian/libimobiledevice-utils.manpages:
 - Install the new manpage.

Show diffs side-by-side

added added

removed removed

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