<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libimobiledevice: libimobiledevice/sbservices.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libimobiledevice <span id="projectnumber">1.0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>libimobiledevice/sbservices.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Implementation to talk to the SpringBoard services on a device.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Represents an error code. <a href="#a50cd3a326f5cf8bff40b128191642fd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structsbservices__client__private.html">sbservices_client_private</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a231d40509606f271317474df92d05ca7"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the springboardservices service on the specified device. <a href="#a9f679612ca911b58fc25d0fa4bdc6d02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> </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>
<tr><td class="mdescLeft"> </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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the icon state of the connected device. <a href="#a56055821b67cd2e33fe34f08d83402ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the icon state of the connected device. <a href="#a09e3a408b178dde88c3c7392fa26af38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the icon of the specified app as PNG data. <a href="#a54afc804c24a74cec55aa1ac50ec1260"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Error Codes</h2></td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_SUCCESS</b>   0</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_INVALID_ARG</b>   -1</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_PLIST_ERROR</b>   -2</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_CONN_FAILED</b>   -3</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SBSERVICES_E_UNKNOWN_ERROR</b>   -256</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implementation to talk to the SpringBoard services on a device. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a231d40509606f271317474df92d05ca7"></a><!-- doxytag: member="sbservices.h::sbservices_client_t" ref="a231d40509606f271317474df92d05ca7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The client handle. </p>
</div>
</div>
<a class="anchor" id="a50cd3a326f5cf8bff40b128191642fd0"></a><!-- doxytag: member="sbservices.h::sbservices_error_t" ref="a50cd3a326f5cf8bff40b128191642fd0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Represents an error code. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7780692fbb6730541acf8ce2d054641f"></a><!-- doxytag: member="sbservices.h::sbservices_client_free" ref="a7780692fbb6730541acf8ce2d054641f" args="(sbservices_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnects an sbservices client from the device and frees up the sbservices client data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The sbservices client to disconnect and free.</td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_client_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a> </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> * </td>
<td class="paramname"><em>client</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the springboardservices service on the specified device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
<tr><td class="paramname">port</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
<tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated sbservices_client_t upon successful return.</td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_pngdata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>bundleId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>pngdata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t * </td>
<td class="paramname"><em>pngsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the icon of the specified app as PNG data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
<tr><td class="paramname">bundleId</td><td>The bundle identifier of the app to retrieve the icon for. </td></tr>
<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>
<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>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a class="anchor" id="a56055821b67cd2e33fe34f08d83402ee"></a><!-- doxytag: member="sbservices.h::sbservices_get_icon_state" ref="a56055821b67cd2e33fe34f08d83402ee" args="(sbservices_client_t client, plist_t *state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_get_icon_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">plist_t * </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the icon state of the connected device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
<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>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a class="anchor" id="a09e3a408b178dde88c3c7392fa26af38"></a><!-- doxytag: member="sbservices.h::sbservices_set_icon_state" ref="a09e3a408b178dde88c3c7392fa26af38" args="(sbservices_client_t client, plist_t newstate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2sbservices_8h.html#a50cd3a326f5cf8bff40b128191642fd0">sbservices_error_t</a> sbservices_set_icon_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsbservices__client__private.html">sbservices_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">plist_t </td>
<td class="paramname"><em>newstate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the icon state of the connected device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
<tr><td class="paramname">newstate</td><td>A plist containing the new iconstate.</td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
