← Back to branch summary

~ubuntu-branches/ubuntu/wily/libimobiledevice/wily

« 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: 2010-05-24 23:39:58 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100524233958-vljg2n4w7pqim0vj
* New upstream release.
* debian/watch: Update.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/include_2libimobiledevice_2sbservices_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"/>
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
5
3
<title>libimobiledevice: libimobiledevice/sbservices.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.1 -->
 
4
<link href="tabs.css" rel="stylesheet" type="text/css">
 
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.9 -->
11
8
<div class="navigation" id="top">
12
9
  <div class="tabs">
13
10
    <ul>
24
21
  </div>
25
22
</div>
26
23
<div class="contents">
27
 
<h1>libimobiledevice/sbservices.h File Reference</h1>
28
 
<p>Implementation to talk to the SpringBoard services on a device.  
29
 
<a href="#_details">More...</a></p>
 
24
<h1>libimobiledevice/sbservices.h File Reference</h1>Implementation to talk to the SpringBoard services on a device.  
 
25
<a href="#_details">More...</a>
 
26
<p>
30
27
<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#a56055821b67cd2e33fe34f08d83402ee">sbservices_get_icon_state</a> (<a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> client, plist_t *state)</td></tr>
42
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the icon state of the connected device.  <a href="#a56055821b67cd2e33fe34f08d83402ee"></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 colspan="2"><h2>Error Codes</h2></td></tr>
48
 
<tr><td colspan="2"><p><a class="anchor" id="amgrp5c244138ac975df1b1cec1afc71a6c9a"></a> </p>
49
 
<br/><br/></td></tr>
50
 
<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="" -->
 
28
<tr><td></td></tr>
 
29
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
 
30
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a></td></tr>
 
31
 
 
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents an error code.  <a href="#50cd3a326f5cf8bff40b128191642fd0"></a><br></td></tr>
 
33
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef sbservices_client_private *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a></td></tr>
 
34
 
 
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The client handle.  <a href="#231d40509606f271317474df92d05ca7"></a><br></td></tr>
 
36
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
37
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#9f679612ca911b58fc25d0fa4bdc6d02">sbservices_client_new</a> (<a class="el" href="libimobiledevice_8h.html#e5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, uint16_t port, <a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a> *client)</td></tr>
 
38
 
 
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects to the springboardservices service on the specified device.  <a href="#9f679612ca911b58fc25d0fa4bdc6d02"></a><br></td></tr>
 
40
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#7780692fbb6730541acf8ce2d054641f">sbservices_client_free</a> (<a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a> client)</td></tr>
 
41
 
 
42
<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="#7780692fbb6730541acf8ce2d054641f"></a><br></td></tr>
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#56055821b67cd2e33fe34f08d83402ee">sbservices_get_icon_state</a> (<a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, plist_t *state)</td></tr>
 
44
 
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the icon state of the connected device.  <a href="#56055821b67cd2e33fe34f08d83402ee"></a><br></td></tr>
 
46
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#09e3a408b178dde88c3c7392fa26af38">sbservices_set_icon_state</a> (<a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, plist_t newstate)</td></tr>
 
47
 
 
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the icon state of the connected device.  <a href="#09e3a408b178dde88c3c7392fa26af38"></a><br></td></tr>
 
49
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#54afc804c24a74cec55aa1ac50ec1260">sbservices_get_icon_pngdata</a> (<a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, const char *bundleId, char **pngdata, uint64_t *pngsize)</td></tr>
 
50
 
 
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the icon of the specified app as PNG data.  <a href="#54afc804c24a74cec55aa1ac50ec1260"></a><br></td></tr>
 
52
<tr><td colspan="2"><br><h2>Error Codes</h2></td></tr>
 
53
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a058c18312e63d4da743dbb852d58bb"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_SUCCESS" ref="2a058c18312e63d4da743dbb852d58bb" args="" -->
51
54
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_SUCCESS</b>&nbsp;&nbsp;&nbsp;0</td></tr>
52
 
<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
 
 
56
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea1e01968d0ffdc53e0f3a17cb76ecf5"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_INVALID_ARG" ref="ea1e01968d0ffdc53e0f3a17cb76ecf5" args="" -->
53
57
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_INVALID_ARG</b>&nbsp;&nbsp;&nbsp;-1</td></tr>
54
 
<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="" -->
 
58
 
 
59
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="419794cdd8ad4383689c70be922dd6be"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_PLIST_ERROR" ref="419794cdd8ad4383689c70be922dd6be" args="" -->
55
60
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_PLIST_ERROR</b>&nbsp;&nbsp;&nbsp;-2</td></tr>
56
 
<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="" -->
 
61
 
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75d5dde9041aaca5f3d3d3cdf3b9079f"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_CONN_FAILED" ref="75d5dde9041aaca5f3d3d3cdf3b9079f" args="" -->
57
63
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_CONN_FAILED</b>&nbsp;&nbsp;&nbsp;-3</td></tr>
58
 
<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="" -->
 
64
 
 
65
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d462482b1f47505745d7e29bd604d173"></a><!-- doxytag: member="include/libimobiledevice/sbservices.h::SBSERVICES_E_UNKNOWN_ERROR" ref="d462482b1f47505745d7e29bd604d173" args="" -->
59
66
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_UNKNOWN_ERROR</b>&nbsp;&nbsp;&nbsp;-256</td></tr>
 
67
 
60
68
</table>
61
 
<hr/><a name="_details"></a><h2>Detailed Description</h2>
62
 
<p>Implementation to talk to the SpringBoard services on a device. </p>
63
 
<hr/><h2>Typedef Documentation</h2>
64
 
<a class="anchor" id="a231d40509606f271317474df92d05ca7"></a><!-- doxytag: member="sbservices.h::sbservices_client_t" ref="a231d40509606f271317474df92d05ca7" args="" -->
65
 
<div class="memitem">
66
 
<div class="memproto">
67
 
      <table class="memname">
68
 
        <tr>
69
 
          <td class="memname">typedef <a class="el" href="structsbservices__client__private.html">sbservices_client_private</a>* <a class="el" href="structsbservices__client__private.html">sbservices_client_t</a></td>
70
 
        </tr>
71
 
      </table>
72
 
</div>
73
 
<div class="memdoc">
74
 
 
75
 
<p>The client handle. </p>
76
 
 
77
 
</div>
78
 
</div>
79
 
<a class="anchor" id="a50cd3a326f5cf8bff40b128191642fd0"></a><!-- doxytag: member="sbservices.h::sbservices_error_t" ref="a50cd3a326f5cf8bff40b128191642fd0" args="" -->
80
 
<div class="memitem">
81
 
<div class="memproto">
82
 
      <table class="memname">
83
 
        <tr>
84
 
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a></td>
85
 
        </tr>
86
 
      </table>
87
 
</div>
88
 
<div class="memdoc">
89
 
 
90
 
<p>Represents an error code. </p>
91
 
 
92
 
</div>
93
 
</div>
94
 
<hr/><h2>Function Documentation</h2>
95
 
<a class="anchor" id="a7780692fbb6730541acf8ce2d054641f"></a><!-- doxytag: member="sbservices.h::sbservices_client_free" ref="a7780692fbb6730541acf8ce2d054641f" args="(sbservices_client_t client)" -->
96
 
<div class="memitem">
97
 
<div class="memproto">
98
 
      <table class="memname">
99
 
        <tr>
100
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_free </td>
 
69
<hr><h2>Detailed Description</h2>
 
70
Implementation to talk to the SpringBoard services on a device. 
 
71
<p>
 
72
<hr><h2>Typedef Documentation</h2>
 
73
<a class="anchor" name="231d40509606f271317474df92d05ca7"></a><!-- doxytag: member="sbservices.h::sbservices_client_t" ref="231d40509606f271317474df92d05ca7" args="" -->
 
74
<div class="memitem">
 
75
<div class="memproto">
 
76
      <table class="memname">
 
77
        <tr>
 
78
          <td class="memname">typedef sbservices_client_private* <a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a>          </td>
 
79
        </tr>
 
80
      </table>
 
81
</div>
 
82
<div class="memdoc">
 
83
 
 
84
<p>
 
85
The client handle. 
 
86
<p>
 
87
 
 
88
</div>
 
89
</div><p>
 
90
<a class="anchor" name="50cd3a326f5cf8bff40b128191642fd0"></a><!-- doxytag: member="sbservices.h::sbservices_error_t" ref="50cd3a326f5cf8bff40b128191642fd0" args="" -->
 
91
<div class="memitem">
 
92
<div class="memproto">
 
93
      <table class="memname">
 
94
        <tr>
 
95
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a>          </td>
 
96
        </tr>
 
97
      </table>
 
98
</div>
 
99
<div class="memdoc">
 
100
 
 
101
<p>
 
102
Represents an error code. 
 
103
<p>
 
104
 
 
105
</div>
 
106
</div><p>
 
107
<hr><h2>Function Documentation</h2>
 
108
<a class="anchor" name="7780692fbb6730541acf8ce2d054641f"></a><!-- doxytag: member="sbservices.h::sbservices_client_free" ref="7780692fbb6730541acf8ce2d054641f" args="(sbservices_client_t client)" -->
 
109
<div class="memitem">
 
110
<div class="memproto">
 
111
      <table class="memname">
 
112
        <tr>
 
113
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_free           </td>
101
114
          <td>(</td>
102
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
103
 
          <td class="paramname"> <em>client</em></td>
 
115
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a>&nbsp;</td>
 
116
          <td class="paramname"> <em>client</em>          </td>
104
117
          <td>&nbsp;)&nbsp;</td>
105
118
          <td></td>
106
119
        </tr>
108
121
</div>
109
122
<div class="memdoc">
110
123
 
111
 
<p>Disconnects an sbservices client from the device and frees up the sbservices client data. </p>
112
 
<dl><dt><b>Parameters:</b></dt><dd>
 
124
<p>
 
125
Disconnects an sbservices client from the device and frees up the sbservices client data. 
 
126
<p>
 
127
<dl compact><dt><b>Parameters:</b></dt><dd>
113
128
  <table border="0" cellspacing="2" cellpadding="0">
114
129
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The sbservices client to disconnect and free.</td></tr>
115
130
  </table>
116
 
  </dd>
117
131
</dl>
118
 
<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>
 
132
<dl class="return" compact><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>
119
133
 
120
134
</div>
121
 
</div>
122
 
<a class="anchor" id="a9f679612ca911b58fc25d0fa4bdc6d02"></a><!-- doxytag: member="sbservices.h::sbservices_client_new" ref="a9f679612ca911b58fc25d0fa4bdc6d02" args="(idevice_t device, uint16_t port, sbservices_client_t *client)" -->
 
135
</div><p>
 
136
<a class="anchor" name="9f679612ca911b58fc25d0fa4bdc6d02"></a><!-- doxytag: member="sbservices.h::sbservices_client_new" ref="9f679612ca911b58fc25d0fa4bdc6d02" args="(idevice_t device, uint16_t port, sbservices_client_t *client)" -->
123
137
<div class="memitem">
124
138
<div class="memproto">
125
139
      <table class="memname">
126
140
        <tr>
127
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_new </td>
 
141
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_new           </td>
128
142
          <td>(</td>
129
 
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&nbsp;</td>
 
143
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#e5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&nbsp;</td>
130
144
          <td class="paramname"> <em>device</em>, </td>
131
145
        </tr>
132
146
        <tr>
138
152
        <tr>
139
153
          <td class="paramkey"></td>
140
154
          <td></td>
141
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> *&nbsp;</td>
 
155
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a> *&nbsp;</td>
142
156
          <td class="paramname"> <em>client</em></td><td>&nbsp;</td>
143
157
        </tr>
144
158
        <tr>
150
164
</div>
151
165
<div class="memdoc">
152
166
 
153
 
<p>Connects to the springboardservices service on the specified device. </p>
154
 
<dl><dt><b>Parameters:</b></dt><dd>
 
167
<p>
 
168
Connects to the springboardservices service on the specified device. 
 
169
<p>
 
170
<dl compact><dt><b>Parameters:</b></dt><dd>
155
171
  <table border="0" cellspacing="2" cellpadding="0">
156
172
    <tr><td valign="top"></td><td valign="top"><em>device</em>&nbsp;</td><td>The device to connect to. </td></tr>
157
173
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
158
174
    <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>
159
175
  </table>
160
 
  </dd>
161
176
</dl>
162
 
<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>
 
177
<dl class="return" compact><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>
163
178
 
164
179
</div>
165
 
</div>
166
 
<a class="anchor" id="a54afc804c24a74cec55aa1ac50ec1260"></a><!-- doxytag: member="sbservices.h::sbservices_get_icon_pngdata" ref="a54afc804c24a74cec55aa1ac50ec1260" args="(sbservices_client_t client, const char *bundleId, char **pngdata, uint64_t *pngsize)" -->
 
180
</div><p>
 
181
<a class="anchor" name="54afc804c24a74cec55aa1ac50ec1260"></a><!-- doxytag: member="sbservices.h::sbservices_get_icon_pngdata" ref="54afc804c24a74cec55aa1ac50ec1260" args="(sbservices_client_t client, const char *bundleId, char **pngdata, uint64_t *pngsize)" -->
167
182
<div class="memitem">
168
183
<div class="memproto">
169
184
      <table class="memname">
170
185
        <tr>
171
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_pngdata </td>
 
186
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_pngdata           </td>
172
187
          <td>(</td>
173
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
 
188
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a>&nbsp;</td>
174
189
          <td class="paramname"> <em>client</em>, </td>
175
190
        </tr>
176
191
        <tr>
200
215
</div>
201
216
<div class="memdoc">
202
217
 
203
 
<p>Get the icon of the specified app as PNG data. </p>
204
 
<dl><dt><b>Parameters:</b></dt><dd>
 
218
<p>
 
219
Get the icon of the specified app as PNG data. 
 
220
<p>
 
221
<dl compact><dt><b>Parameters:</b></dt><dd>
205
222
  <table border="0" cellspacing="2" cellpadding="0">
206
223
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. </td></tr>
207
224
    <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. </td></tr>
208
225
    <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. </td></tr>
209
226
    <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>
210
227
  </table>
211
 
  </dd>
212
228
</dl>
213
 
<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>
 
229
<dl class="return" compact><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>
214
230
 
215
231
</div>
216
 
</div>
217
 
<a class="anchor" id="a56055821b67cd2e33fe34f08d83402ee"></a><!-- doxytag: member="sbservices.h::sbservices_get_icon_state" ref="a56055821b67cd2e33fe34f08d83402ee" args="(sbservices_client_t client, plist_t *state)" -->
 
232
</div><p>
 
233
<a class="anchor" name="56055821b67cd2e33fe34f08d83402ee"></a><!-- doxytag: member="sbservices.h::sbservices_get_icon_state" ref="56055821b67cd2e33fe34f08d83402ee" args="(sbservices_client_t client, plist_t *state)" -->
218
234
<div class="memitem">
219
235
<div class="memproto">
220
236
      <table class="memname">
221
237
        <tr>
222
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_state </td>
 
238
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_state           </td>
223
239
          <td>(</td>
224
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
 
240
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a>&nbsp;</td>
225
241
          <td class="paramname"> <em>client</em>, </td>
226
242
        </tr>
227
243
        <tr>
239
255
</div>
240
256
<div class="memdoc">
241
257
 
242
 
<p>Gets the icon state of the connected device. </p>
243
 
<dl><dt><b>Parameters:</b></dt><dd>
 
258
<p>
 
259
Gets the icon state of the connected device. 
 
260
<p>
 
261
<dl compact><dt><b>Parameters:</b></dt><dd>
244
262
  <table border="0" cellspacing="2" cellpadding="0">
245
263
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. </td></tr>
246
264
    <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.</td></tr>
247
265
  </table>
248
 
  </dd>
249
266
</dl>
250
 
<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>
 
267
<dl class="return" compact><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>
251
268
 
252
269
</div>
253
 
</div>
254
 
<a class="anchor" id="a09e3a408b178dde88c3c7392fa26af38"></a><!-- doxytag: member="sbservices.h::sbservices_set_icon_state" ref="a09e3a408b178dde88c3c7392fa26af38" args="(sbservices_client_t client, plist_t newstate)" -->
 
270
</div><p>
 
271
<a class="anchor" name="09e3a408b178dde88c3c7392fa26af38"></a><!-- doxytag: member="sbservices.h::sbservices_set_icon_state" ref="09e3a408b178dde88c3c7392fa26af38" args="(sbservices_client_t client, plist_t newstate)" -->
255
272
<div class="memitem">
256
273
<div class="memproto">
257
274
      <table class="memname">
258
275
        <tr>
259
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_set_icon_state </td>
 
276
          <td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_set_icon_state           </td>
260
277
          <td>(</td>
261
 
          <td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a>&nbsp;</td>
 
278
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#231d40509606f271317474df92d05ca7">sbservices_client_t</a>&nbsp;</td>
262
279
          <td class="paramname"> <em>client</em>, </td>
263
280
        </tr>
264
281
        <tr>
276
293
</div>
277
294
<div class="memdoc">
278
295
 
279
 
<p>Sets the icon state of the connected device. </p>
280
 
<dl><dt><b>Parameters:</b></dt><dd>
 
296
<p>
 
297
Sets the icon state of the connected device. 
 
298
<p>
 
299
<dl compact><dt><b>Parameters:</b></dt><dd>
281
300
  <table border="0" cellspacing="2" cellpadding="0">
282
301
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The connected sbservices client to use. </td></tr>
283
302
    <tr><td valign="top"></td><td valign="top"><em>newstate</em>&nbsp;</td><td>A plist containing the new iconstate.</td></tr>
284
303
  </table>
285
 
  </dd>
286
304
</dl>
287
 
<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>
 
305
<dl class="return" compact><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>
288
306
 
289
307
</div>
290
 
</div>
291
 
</div>
292
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Mar 21 09:43:44 2010 for libimobiledevice by&nbsp;
293
 
<a href="http://www.doxygen.org/index.html">
294
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
 
308
</div><p>
 
309
</div>
 
310
<hr size="1"><address style="text-align: right;"><small><a href="http://www.doxygen.org/index.html">
 
311
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> </small></address>
295
312
</body>
296
313
</html>