← 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_2screenshotr_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_2screenshotr_8h.html
25
25
</div>
26
26
<div class="contents">
27
27
<h1>libimobiledevice/screenshotr.h File Reference</h1>
28
 
<p>Screenshot service implementation.  
 
28
<p>Retrieve a screenshot from device.  
29
29
<a href="#_details">More...</a></p>
30
30
<table border="0" cellpadding="0" cellspacing="0">
31
31
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
58
58
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_UNKNOWN_ERROR</b>&nbsp;&nbsp;&nbsp;-256</td></tr>
59
59
</table>
60
60
<hr/><a name="_details"></a><h2>Detailed Description</h2>
61
 
<p>Screenshot service implementation. </p>
 
61
<p>Retrieve a screenshot from device. </p>
 
62
<dl class="note"><dt><b>Note:</b></dt><dd>Requires a mounted developer image. </dd></dl>
62
63
<hr/><h2>Typedef Documentation</h2>
63
64
<a class="anchor" id="a984c34c0d361e1dcf6a8ea8f42a3a8a2"></a><!-- doxytag: member="screenshotr.h::screenshotr_client_t" ref="a984c34c0d361e1dcf6a8ea8f42a3a8a2" args="" -->
64
65
<div class="memitem">
152
153
<p>Connects to the screenshotr service on the specified device. </p>
153
154
<dl><dt><b>Parameters:</b></dt><dd>
154
155
  <table border="0" cellspacing="2" cellpadding="0">
155
 
    <tr><td valign="top"></td><td valign="top"><em>device</em>&nbsp;</td><td>The device to connect to. </td></tr>
156
 
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
 
156
    <tr><td valign="top"></td><td valign="top"><em>device</em>&nbsp;</td><td>The device to connect to. <dl><dt><b>Parameters:</b></dt><dd>
 
157
  <table border="0" cellspacing="2" cellpadding="0">
 
158
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>Destination port (usually given by lockdownd_start_service). <dl><dt><b>Parameters:</b></dt><dd>
 
159
  <table border="0" cellspacing="2" cellpadding="0">
157
160
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>Pointer that will be set to a newly allocated screenshotr_client_t upon successful return.</td></tr>
158
161
  </table>
159
162
  </dd>
160
163
</dl>
161
164
<dl class="note"><dt><b>Note:</b></dt><dd>This service is only available if a developer disk image has been mounted.</dd></dl>
162
165
<dl class="return"><dt><b>Returns:</b></dt><dd>SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID ARG if one or more parameters are invalid, or SCREENSHOTR_E_CONN_FAILED if the connection to the device could not be established. </dd></dl>
 
166
</td></tr>
 
167
  </table>
 
168
  </dd>
 
169
</dl>
 
170
</td></tr>
 
171
  </table>
 
172
  </dd>
 
173
</dl>
163
174
 
164
175
</div>
165
176
</div>
197
208
<p>Get a screen shot from the connected device. </p>
198
209
<dl><dt><b>Parameters:</b></dt><dd>
199
210
  <table border="0" cellspacing="2" cellpadding="0">
200
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connection screenshotr service client. </td></tr>
201
 
    <tr><td valign="top"></td><td valign="top"><em>imgdata</em>&nbsp;</td><td>Pointer that will point to a newly allocated buffer containing TIFF image data upon successful return. It is up to the caller to free the memory. </td></tr>
 
211
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connection screenshotr service client. <dl><dt><b>Parameters:</b></dt><dd>
 
212
  <table border="0" cellspacing="2" cellpadding="0">
 
213
    <tr><td valign="top"></td><td valign="top"><em>imgdata</em>&nbsp;</td><td>Pointer that will point to a newly allocated buffer containing TIFF image data upon successful return. It is up to the caller to free the memory. <dl><dt><b>Parameters:</b></dt><dd>
 
214
  <table border="0" cellspacing="2" cellpadding="0">
202
215
    <tr><td valign="top"></td><td valign="top"><em>imgsize</em>&nbsp;</td><td>Pointer to a uint64_t that will be set to the size of the buffer imgdata points to upon successful return.</td></tr>
203
216
  </table>
204
217
  </dd>
205
218
</dl>
206
219
<dl class="return"><dt><b>Returns:</b></dt><dd>SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID_ARG if one or more parameters are invalid, or another error code if an error occured. </dd></dl>
 
220
</td></tr>
 
221
  </table>
 
222
  </dd>
 
223
</dl>
 
224
</td></tr>
 
225
  </table>
 
226
  </dd>
 
227
</dl>
207
228
 
208
229
</div>
209
230
</div>
210
231
</div>
211
 
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Nov 27 19:58:07 2010 for libimobiledevice by&nbsp;
 
232
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Dec 16 22:53:47 2010 for libimobiledevice by&nbsp;
212
233
<a href="http://www.doxygen.org/index.html">
213
234
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
214
235
</body>