← 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_2sbservices_8h.html

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2011-04-30 13:28:43 UTC
  • mfrom: (2.1.10 experimental)
  • Revision ID: james.westby@ubuntu.com-20110430132843-hivpq380w8x0h1x0
Tags: 1.1.1-1
http://bugs.debian.org/620065
https://launchpad.net/bugs/693895
* New upstream release.
* debian/changelog: Fix typo in previous entry.
* debian/patches:
 - 90_fix_4.3_iOS.patch: Merged upstream.
* debian/libimobiledevice-utils.manpages:
 - Add man page for idevicebackup2.
 - Add man page for idevicedate.
 - Add upstream man pages for ideviceenterrecovery and idevicepair.
* debian/control:
 - Remove Conflitcs of libimobiledevice2 to make it installable with
   libimobiledevice1 (Closes: #620065).
 - Add Conflicts/Replaces also on libimobiledevice0-dbg (LP: #693895)
 - Remove python-support from Build-Depends.
 - Increase required python-all-dev package version to 2.6.6-3~.
 - Remove XB-Python-Version fields.
 - Add X-Python-Version field.
 - Bump Standards-Version to 3.9.2.0 (no change needed).
* debian/copyright:
 - Update copyright years.
* debian/libimobiledevice2.symbols:
 - Update with new symbols.
* debian/rules:
 - Use --with python2.
 - Pass --no-guessing-versions to dh_python2 to build only with default
   python version.
* debian/pycompat:
 - Removed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/include_2libimobiledevice_2sbservices_8h.html
7
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
8
</head>
9
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>
 
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>
16
27
      <li class="current"><a href="files.html"><span>Files</span></a></li>
17
28
    </ul>
18
29
  </div>
19
 
  <div class="tabs">
20
 
    <ul>
21
 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
 
30
  <div id="navrow2" class="tabs2">
 
31
    <ul class="tablist">
 
32
      <li><a href="files.html"><span>File&#160;List</span></a></li>
22
33
      <li><a href="globals.html"><span>Globals</span></a></li>
23
34
    </ul>
24
35
  </div>
25
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/sbservices.h File Reference</h1>  </div>
 
43
</div>
26
44
<div class="contents">
27
 
<h1>libimobiledevice/sbservices.h File Reference</h1>
 
45
 
28
46
<p>Manage SpringBoard icons and retrieve icon images.  
29
47
<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_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a></td></tr>
33
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents an error code.  <a href="#a50cd3a326f5cf8bff40b128191642fd0"></a><br/></td></tr>
34
 
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structsbservices__client__private.html">sbservices_client_private</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a></td></tr>
35
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The client handle.  <a href="#a231d40509606f271317474df92d05ca7"></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_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a9f679612ca911b58fc25d0fa4bdc6d02">sbservices_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> *client)</td></tr>
38
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects to the springboardservices service on the specified device.  <a href="#a9f679612ca911b58fc25d0fa4bdc6d02"></a><br/></td></tr>
39
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a7780692fbb6730541acf8ce2d054641f">sbservices_client_free</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client)</td></tr>
40
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disconnects an sbservices client from the device and frees up the sbservices client data.  <a href="#a7780692fbb6730541acf8ce2d054641f"></a><br/></td></tr>
41
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#af46584eb04ec7e47b92a8fc972a770c1">sbservices_get_icon_state</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, plist_t *state, const char *format_version)</td></tr>
42
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the icon state of the connected device.  <a href="#af46584eb04ec7e47b92a8fc972a770c1"></a><br/></td></tr>
43
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a09e3a408b178dde88c3c7392fa26af38">sbservices_set_icon_state</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, plist_t newstate)</td></tr>
44
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the icon state of the connected device.  <a href="#a09e3a408b178dde88c3c7392fa26af38"></a><br/></td></tr>
45
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a54afc804c24a74cec55aa1ac50ec1260">sbservices_get_icon_pngdata</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, const char *bundleId, char **pngdata, uint64_t *pngsize)</td></tr>
46
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the icon of the specified app as PNG data.  <a href="#a54afc804c24a74cec55aa1ac50ec1260"></a><br/></td></tr>
47
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#ad9e7f78459d7c4fc8030bb880155e77e">sbservices_get_home_screen_wallpaper_pngdata</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, char **pngdata, uint64_t *pngsize)</td></tr>
48
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the home screen wallpaper as PNG data.  <a href="#ad9e7f78459d7c4fc8030bb880155e77e"></a><br/></td></tr>
49
 
<tr><td colspan="2"><h2>Error Codes</h2></td></tr>
50
 
<tr><td colspan="2"><p><a class="anchor" id="amgrp5c244138ac975df1b1cec1afc71a6c9a"></a> </p>
51
 
<br/><br/></td></tr>
 
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_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a></td></tr>
 
52
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an error code.  <a href="#a50cd3a326f5cf8bff40b128191642fd0"></a><br/></td></tr>
 
53
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structsbservices__client__private.html">sbservices_client_private</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a></td></tr>
 
54
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle.  <a href="#a231d40509606f271317474df92d05ca7"></a><br/></td></tr>
 
55
<tr><td colspan="2"><h2><a name="func-members"></a>
 
56
Functions</h2></td></tr>
 
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a9f679612ca911b58fc25d0fa4bdc6d02">sbservices_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> *client)</td></tr>
 
58
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the springboardservices service on the specified device.  <a href="#a9f679612ca911b58fc25d0fa4bdc6d02"></a><br/></td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a7780692fbb6730541acf8ce2d054641f">sbservices_client_free</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client)</td></tr>
 
60
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects an sbservices client from the device and frees up the sbservices client data.  <a href="#a7780692fbb6730541acf8ce2d054641f"></a><br/></td></tr>
 
61
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#af46584eb04ec7e47b92a8fc972a770c1">sbservices_get_icon_state</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, plist_t *state, const char *format_version)</td></tr>
 
62
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the icon state of the connected device.  <a href="#af46584eb04ec7e47b92a8fc972a770c1"></a><br/></td></tr>
 
63
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a09e3a408b178dde88c3c7392fa26af38">sbservices_set_icon_state</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, plist_t newstate)</td></tr>
 
64
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the icon state of the connected device.  <a href="#a09e3a408b178dde88c3c7392fa26af38"></a><br/></td></tr>
 
65
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a54afc804c24a74cec55aa1ac50ec1260">sbservices_get_icon_pngdata</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, const char *bundleId, char **pngdata, uint64_t *pngsize)</td></tr>
 
66
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the icon of the specified app as PNG data.  <a href="#a54afc804c24a74cec55aa1ac50ec1260"></a><br/></td></tr>
 
67
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#ad9e7f78459d7c4fc8030bb880155e77e">sbservices_get_home_screen_wallpaper_pngdata</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, char **pngdata, uint64_t *pngsize)</td></tr>
 
68
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the home screen wallpaper as PNG data.  <a href="#ad9e7f78459d7c4fc8030bb880155e77e"></a><br/></td></tr>
 
69
<tr><td colspan="2"><h2><a name="member-group"></a>
 
70
Error Codes</h2></td></tr>
52
71
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a058c18312e63d4da743dbb852d58bb"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_SUCCESS" ref="a2a058c18312e63d4da743dbb852d58bb" args="" -->
53
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_SUCCESS</b>&nbsp;&nbsp;&nbsp;0</td></tr>
 
72
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_SUCCESS</b>&#160;&#160;&#160;0</td></tr>
54
73
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea1e01968d0ffdc53e0f3a17cb76ecf5"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_INVALID_ARG" ref="aea1e01968d0ffdc53e0f3a17cb76ecf5" args="" -->
55
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_INVALID_ARG</b>&nbsp;&nbsp;&nbsp;-1</td></tr>
 
74
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_INVALID_ARG</b>&#160;&#160;&#160;-1</td></tr>
56
75
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a419794cdd8ad4383689c70be922dd6be"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_PLIST_ERROR" ref="a419794cdd8ad4383689c70be922dd6be" args="" -->
57
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_PLIST_ERROR</b>&nbsp;&nbsp;&nbsp;-2</td></tr>
 
76
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_PLIST_ERROR</b>&#160;&#160;&#160;-2</td></tr>
58
77
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75d5dde9041aaca5f3d3d3cdf3b9079f"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_CONN_FAILED" ref="a75d5dde9041aaca5f3d3d3cdf3b9079f" args="" -->
59
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_CONN_FAILED</b>&nbsp;&nbsp;&nbsp;-3</td></tr>
 
78
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_CONN_FAILED</b>&#160;&#160;&#160;-3</td></tr>
60
79
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad462482b1f47505745d7e29bd604d173"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_UNKNOWN_ERROR" ref="ad462482b1f47505745d7e29bd604d173" args="" -->
61
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_UNKNOWN_ERROR</b>&nbsp;&nbsp;&nbsp;-256</td></tr>
 
80
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_UNKNOWN_ERROR</b>&#160;&#160;&#160;-256</td></tr>
62
81
</table>
63
82
<hr/><a name="_details"></a><h2>Detailed Description</h2>
64
 
<p>Manage SpringBoard icons and retrieve icon images. </p>
65
 
<hr/><h2>Typedef Documentation</h2>
 
83
<div class="textblock"><p>Manage SpringBoard icons and retrieve icon images. </p>
 
84
</div><hr/><h2>Typedef Documentation</h2>
66
85
<a class="anchor" id="a231d40509606f271317474df92d05ca7"></a><!-- doxytag: member="sbservices.h::sbservices_client_t" ref="a231d40509606f271317474df92d05ca7" args="" -->
67
86
<div class="memitem">
68
87
<div class="memproto">
101
120
        <tr>
102
121
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_free </td>
103
122
          <td>(</td>
104
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
105
 
          <td class="paramname"> <em>client</em></td>
106
 
          <td>&nbsp;)&nbsp;</td>
 
123
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&#160;</td>
 
124
          <td class="paramname"><em>client</em></td><td>)</td>
107
125
          <td></td>
108
126
        </tr>
109
127
      </table>
112
130
 
113
131
<p>Disconnects an sbservices client from the device and frees up the sbservices client data. </p>
114
132
<dl><dt><b>Parameters:</b></dt><dd>
115
 
  <table border="0" cellspacing="2" cellpadding="0">
116
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The sbservices client to disconnect and free.</td></tr>
 
133
  <table class="params">
 
134
    <tr><td class="paramname">client</td><td>The sbservices client to disconnect and free.</td></tr>
117
135
  </table>
118
136
  </dd>
119
137
</dl>
128
146
        <tr>
129
147
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_new </td>
130
148
          <td>(</td>
131
 
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&nbsp;</td>
132
 
          <td class="paramname"> <em>device</em>, </td>
133
 
        </tr>
134
 
        <tr>
135
 
          <td class="paramkey"></td>
136
 
          <td></td>
137
 
          <td class="paramtype">uint16_t&nbsp;</td>
138
 
          <td class="paramname"> <em>port</em>, </td>
139
 
        </tr>
140
 
        <tr>
141
 
          <td class="paramkey"></td>
142
 
          <td></td>
143
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> *&nbsp;</td>
144
 
          <td class="paramname"> <em>client</em></td><td>&nbsp;</td>
 
149
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&#160;</td>
 
150
          <td class="paramname"><em>device</em>, </td>
 
151
        </tr>
 
152
        <tr>
 
153
          <td class="paramkey"></td>
 
154
          <td></td>
 
155
          <td class="paramtype">uint16_t&#160;</td>
 
156
          <td class="paramname"><em>port</em>, </td>
 
157
        </tr>
 
158
        <tr>
 
159
          <td class="paramkey"></td>
 
160
          <td></td>
 
161
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> *&#160;</td>
 
162
          <td class="paramname"><em>client</em>&#160;</td>
145
163
        </tr>
146
164
        <tr>
147
165
          <td></td>
148
166
          <td>)</td>
149
 
          <td></td><td></td><td></td>
 
167
          <td></td><td></td>
150
168
        </tr>
151
169
      </table>
152
170
</div>
154
172
 
155
173
<p>Connects to the springboardservices service on the specified device. </p>
156
174
<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>device</em>&nbsp;</td><td>The device to connect to. <dl><dt><b>Parameters:</b></dt><dd>
159
 
  <table border="0" cellspacing="2" cellpadding="0">
160
 
    <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>
161
 
  <table border="0" cellspacing="2" cellpadding="0">
162
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>Pointer that will point to a newly allocated sbservices_client_t upon successful return.</td></tr>
 
175
  <table class="params">
 
176
    <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
 
177
    <tr><td class="paramname">port</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
 
178
    <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated sbservices_client_t upon successful return.</td></tr>
163
179
  </table>
164
180
  </dd>
165
181
</dl>
166
182
<dl class="return"><dt><b>Returns:</b></dt><dd>SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise. </dd></dl>
167
 
</td></tr>
168
 
  </table>
169
 
  </dd>
170
 
</dl>
171
 
</td></tr>
172
 
  </table>
173
 
  </dd>
174
 
</dl>
175
183
 
176
184
</div>
177
185
</div>
182
190
        <tr>
183
191
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_home_screen_wallpaper_pngdata </td>
184
192
          <td>(</td>
185
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
186
 
          <td class="paramname"> <em>client</em>, </td>
187
 
        </tr>
188
 
        <tr>
189
 
          <td class="paramkey"></td>
190
 
          <td></td>
191
 
          <td class="paramtype">char **&nbsp;</td>
192
 
          <td class="paramname"> <em>pngdata</em>, </td>
193
 
        </tr>
194
 
        <tr>
195
 
          <td class="paramkey"></td>
196
 
          <td></td>
197
 
          <td class="paramtype">uint64_t *&nbsp;</td>
198
 
          <td class="paramname"> <em>pngsize</em></td><td>&nbsp;</td>
 
193
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&#160;</td>
 
194
          <td class="paramname"><em>client</em>, </td>
 
195
        </tr>
 
196
        <tr>
 
197
          <td class="paramkey"></td>
 
198
          <td></td>
 
199
          <td class="paramtype">char **&#160;</td>
 
200
          <td class="paramname"><em>pngdata</em>, </td>
 
201
        </tr>
 
202
        <tr>
 
203
          <td class="paramkey"></td>
 
204
          <td></td>
 
205
          <td class="paramtype">uint64_t *&#160;</td>
 
206
          <td class="paramname"><em>pngsize</em>&#160;</td>
199
207
        </tr>
200
208
        <tr>
201
209
          <td></td>
202
210
          <td>)</td>
203
 
          <td></td><td></td><td></td>
 
211
          <td></td><td></td>
204
212
        </tr>
205
213
      </table>
206
214
</div>
208
216
 
209
217
<p>Get the home screen wallpaper as PNG data. </p>
210
218
<dl><dt><b>Parameters:</b></dt><dd>
211
 
  <table border="0" cellspacing="2" cellpadding="0">
212
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. <dl><dt><b>Parameters:</b></dt><dd>
213
 
  <table border="0" cellspacing="2" cellpadding="0">
214
 
    <tr><td valign="top"></td><td valign="top"><em>pngdata</em>&nbsp;</td><td>Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. <dl><dt><b>Parameters:</b></dt><dd>
215
 
  <table border="0" cellspacing="2" cellpadding="0">
216
 
    <tr><td valign="top"></td><td valign="top"><em>pngsize</em>&nbsp;</td><td>Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return.</td></tr>
 
219
  <table class="params">
 
220
    <tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
 
221
    <tr><td class="paramname">pngdata</td><td>Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. </td></tr>
 
222
    <tr><td class="paramname">pngsize</td><td>Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return.</td></tr>
217
223
  </table>
218
224
  </dd>
219
225
</dl>
220
226
<dl class="return"><dt><b>Returns:</b></dt><dd>SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or pngdata are invalid, or an SBSERVICES_E_* error code otherwise. </dd></dl>
221
 
</td></tr>
222
 
  </table>
223
 
  </dd>
224
 
</dl>
225
 
</td></tr>
226
 
  </table>
227
 
  </dd>
228
 
</dl>
229
227
 
230
228
</div>
231
229
</div>
236
234
        <tr>
237
235
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_pngdata </td>
238
236
          <td>(</td>
239
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
240
 
          <td class="paramname"> <em>client</em>, </td>
241
 
        </tr>
242
 
        <tr>
243
 
          <td class="paramkey"></td>
244
 
          <td></td>
245
 
          <td class="paramtype">const char *&nbsp;</td>
246
 
          <td class="paramname"> <em>bundleId</em>, </td>
247
 
        </tr>
248
 
        <tr>
249
 
          <td class="paramkey"></td>
250
 
          <td></td>
251
 
          <td class="paramtype">char **&nbsp;</td>
252
 
          <td class="paramname"> <em>pngdata</em>, </td>
253
 
        </tr>
254
 
        <tr>
255
 
          <td class="paramkey"></td>
256
 
          <td></td>
257
 
          <td class="paramtype">uint64_t *&nbsp;</td>
258
 
          <td class="paramname"> <em>pngsize</em></td><td>&nbsp;</td>
 
237
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&#160;</td>
 
238
          <td class="paramname"><em>client</em>, </td>
 
239
        </tr>
 
240
        <tr>
 
241
          <td class="paramkey"></td>
 
242
          <td></td>
 
243
          <td class="paramtype">const char *&#160;</td>
 
244
          <td class="paramname"><em>bundleId</em>, </td>
 
245
        </tr>
 
246
        <tr>
 
247
          <td class="paramkey"></td>
 
248
          <td></td>
 
249
          <td class="paramtype">char **&#160;</td>
 
250
          <td class="paramname"><em>pngdata</em>, </td>
 
251
        </tr>
 
252
        <tr>
 
253
          <td class="paramkey"></td>
 
254
          <td></td>
 
255
          <td class="paramtype">uint64_t *&#160;</td>
 
256
          <td class="paramname"><em>pngsize</em>&#160;</td>
259
257
        </tr>
260
258
        <tr>
261
259
          <td></td>
262
260
          <td>)</td>
263
 
          <td></td><td></td><td></td>
 
261
          <td></td><td></td>
264
262
        </tr>
265
263
      </table>
266
264
</div>
268
266
 
269
267
<p>Get the icon of the specified app as PNG data. </p>
270
268
<dl><dt><b>Parameters:</b></dt><dd>
271
 
  <table border="0" cellspacing="2" cellpadding="0">
272
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. <dl><dt><b>Parameters:</b></dt><dd>
273
 
  <table border="0" cellspacing="2" cellpadding="0">
274
 
    <tr><td valign="top"></td><td valign="top"><em>bundleId</em>&nbsp;</td><td>The bundle identifier of the app to retrieve the icon for. <dl><dt><b>Parameters:</b></dt><dd>
275
 
  <table border="0" cellspacing="2" cellpadding="0">
276
 
    <tr><td valign="top"></td><td valign="top"><em>pngdata</em>&nbsp;</td><td>Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. <dl><dt><b>Parameters:</b></dt><dd>
277
 
  <table border="0" cellspacing="2" cellpadding="0">
278
 
    <tr><td valign="top"></td><td valign="top"><em>pngsize</em>&nbsp;</td><td>Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return.</td></tr>
 
269
  <table class="params">
 
270
    <tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
 
271
    <tr><td class="paramname">bundleId</td><td>The bundle identifier of the app to retrieve the icon for. </td></tr>
 
272
    <tr><td class="paramname">pngdata</td><td>Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. </td></tr>
 
273
    <tr><td class="paramname">pngsize</td><td>Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return.</td></tr>
279
274
  </table>
280
275
  </dd>
281
276
</dl>
282
277
<dl class="return"><dt><b>Returns:</b></dt><dd>SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client, bundleId, or pngdata are invalid, or an SBSERVICES_E_* error code otherwise. </dd></dl>
283
 
</td></tr>
284
 
  </table>
285
 
  </dd>
286
 
</dl>
287
 
</td></tr>
288
 
  </table>
289
 
  </dd>
290
 
</dl>
291
 
</td></tr>
292
 
  </table>
293
 
  </dd>
294
 
</dl>
295
278
 
296
279
</div>
297
280
</div>
302
285
        <tr>
303
286
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_state </td>
304
287
          <td>(</td>
305
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
306
 
          <td class="paramname"> <em>client</em>, </td>
307
 
        </tr>
308
 
        <tr>
309
 
          <td class="paramkey"></td>
310
 
          <td></td>
311
 
          <td class="paramtype">plist_t *&nbsp;</td>
312
 
          <td class="paramname"> <em>state</em>, </td>
313
 
        </tr>
314
 
        <tr>
315
 
          <td class="paramkey"></td>
316
 
          <td></td>
317
 
          <td class="paramtype">const char *&nbsp;</td>
318
 
          <td class="paramname"> <em>format_version</em></td><td>&nbsp;</td>
 
288
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&#160;</td>
 
289
          <td class="paramname"><em>client</em>, </td>
 
290
        </tr>
 
291
        <tr>
 
292
          <td class="paramkey"></td>
 
293
          <td></td>
 
294
          <td class="paramtype">plist_t *&#160;</td>
 
295
          <td class="paramname"><em>state</em>, </td>
 
296
        </tr>
 
297
        <tr>
 
298
          <td class="paramkey"></td>
 
299
          <td></td>
 
300
          <td class="paramtype">const char *&#160;</td>
 
301
          <td class="paramname"><em>format_version</em>&#160;</td>
319
302
        </tr>
320
303
        <tr>
321
304
          <td></td>
322
305
          <td>)</td>
323
 
          <td></td><td></td><td></td>
 
306
          <td></td><td></td>
324
307
        </tr>
325
308
      </table>
326
309
</div>
328
311
 
329
312
<p>Gets the icon state of the connected device. </p>
330
313
<dl><dt><b>Parameters:</b></dt><dd>
331
 
  <table border="0" cellspacing="2" cellpadding="0">
332
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. <dl><dt><b>Parameters:</b></dt><dd>
333
 
  <table border="0" cellspacing="2" cellpadding="0">
334
 
    <tr><td valign="top"></td><td valign="top"><em>state</em>&nbsp;</td><td>Pointer that will point to a newly allocated plist containing the current icon state. It is up to the caller to free the memory. <dl><dt><b>Parameters:</b></dt><dd>
335
 
  <table border="0" cellspacing="2" cellpadding="0">
336
 
    <tr><td valign="top"></td><td valign="top"><em>format_version</em>&nbsp;</td><td>A string to be passed as formatVersion along with the request, or NULL if no formatVersion should be passed. This is only supported since iOS 4.0 so for older firmware versions this must be set to NULL.</td></tr>
 
314
  <table class="params">
 
315
    <tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
 
316
    <tr><td class="paramname">state</td><td>Pointer that will point to a newly allocated plist containing the current icon state. It is up to the caller to free the memory. </td></tr>
 
317
    <tr><td class="paramname">format_version</td><td>A string to be passed as formatVersion along with the request, or NULL if no formatVersion should be passed. This is only supported since iOS 4.0 so for older firmware versions this must be set to NULL.</td></tr>
337
318
  </table>
338
319
  </dd>
339
320
</dl>
340
321
<dl class="return"><dt><b>Returns:</b></dt><dd>SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or state is invalid, or an SBSERVICES_E_* error code otherwise. </dd></dl>
341
 
</td></tr>
342
 
  </table>
343
 
  </dd>
344
 
</dl>
345
 
</td></tr>
346
 
  </table>
347
 
  </dd>
348
 
</dl>
349
322
 
350
323
</div>
351
324
</div>
356
329
        <tr>
357
330
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_set_icon_state </td>
358
331
          <td>(</td>
359
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
360
 
          <td class="paramname"> <em>client</em>, </td>
 
332
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&#160;</td>
 
333
          <td class="paramname"><em>client</em>, </td>
361
334
        </tr>
362
335
        <tr>
363
336
          <td class="paramkey"></td>
364
337
          <td></td>
365
 
          <td class="paramtype">plist_t&nbsp;</td>
366
 
          <td class="paramname"> <em>newstate</em></td><td>&nbsp;</td>
 
338
          <td class="paramtype">plist_t&#160;</td>
 
339
          <td class="paramname"><em>newstate</em>&#160;</td>
367
340
        </tr>
368
341
        <tr>
369
342
          <td></td>
370
343
          <td>)</td>
371
 
          <td></td><td></td><td></td>
 
344
          <td></td><td></td>
372
345
        </tr>
373
346
      </table>
374
347
</div>
376
349
 
377
350
<p>Sets the icon state of the connected device. </p>
378
351
<dl><dt><b>Parameters:</b></dt><dd>
379
 
  <table border="0" cellspacing="2" cellpadding="0">
380
 
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. <dl><dt><b>Parameters:</b></dt><dd>
381
 
  <table border="0" cellspacing="2" cellpadding="0">
382
 
    <tr><td valign="top"></td><td valign="top"><em>newstate</em>&nbsp;</td><td>A plist containing the new iconstate.</td></tr>
 
352
  <table class="params">
 
353
    <tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
 
354
    <tr><td class="paramname">newstate</td><td>A plist containing the new iconstate.</td></tr>
383
355
  </table>
384
356
  </dd>
385
357
</dl>
386
358
<dl class="return"><dt><b>Returns:</b></dt><dd>SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or newstate is NULL, or an SBSERVICES_E_* error code otherwise. </dd></dl>
387
 
</td></tr>
388
 
  </table>
389
 
  </dd>
390
 
</dl>
391
359
 
392
360
</div>
393
361
</div>
394
362
</div>
395
 
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Dec 16 22:53:47 2010 for libimobiledevice by&nbsp;
 
363
<hr class="footer"/><address class="footer"><small>Generated by&#160;
396
364
<a href="http://www.doxygen.org/index.html">
397
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 
365
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
398
366
</body>
399
367
</html>