| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483 |
- <!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"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.8"/>
- <title>libimobiledevice: libimobiledevice/sbservices.h File Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <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.2.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.8 -->
- <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 id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#define-members">Macros</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">sbservices.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Manage SpringBoard icons and retrieve icon images.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:a87ee6989c94556d8a01ee95bd6a4413f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87ee6989c94556d8a01ee95bd6a4413f"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>SBSERVICES_SERVICE_NAME</b>   "com.apple.springboardservices"</td></tr>
- <tr class="separator:a87ee6989c94556d8a01ee95bd6a4413f"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:affc88715f133c58f6b5b33a1d60e5010"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affc88715f133c58f6b5b33a1d60e5010"></a>
- typedef struct <br class="typebreak" />
- sbservices_client_private </td><td class="memItemRight" valign="bottom"><b>sbservices_client_private</b></td></tr>
- <tr class="separator:affc88715f133c58f6b5b33a1d60e5010"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a231d40509606f271317474df92d05ca7"><td class="memItemLeft" align="right" valign="top">typedef sbservices_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a></td></tr>
- <tr class="memdesc:a231d40509606f271317474df92d05ca7"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a231d40509606f271317474df92d05ca7">More...</a><br /></td></tr>
- <tr class="separator:a231d40509606f271317474df92d05ca7"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:a43ade5690c1a32fd0ca8e370c9e7b7cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43ade5690c1a32fd0ca8e370c9e7b7cc"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> { <br />
-   <b>SBSERVICES_E_SUCCESS</b> = 0,
- <br />
-   <b>SBSERVICES_E_INVALID_ARG</b> = -1,
- <br />
-   <b>SBSERVICES_E_PLIST_ERROR</b> = -2,
- <br />
-   <b>SBSERVICES_E_CONN_FAILED</b> = -3,
- <br />
-   <b>SBSERVICES_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a43ade5690c1a32fd0ca8e370c9e7b7cc"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a43ade5690c1a32fd0ca8e370c9e7b7cc"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a486ff2a5dd18c39ea4b4fc972c819dd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a486ff2a5dd18c39ea4b4fc972c819dd9">sbservices_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> *client)</td></tr>
- <tr class="memdesc:a486ff2a5dd18c39ea4b4fc972c819dd9"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the springboardservices service on the specified device. <a href="#a486ff2a5dd18c39ea4b4fc972c819dd9">More...</a><br /></td></tr>
- <tr class="separator:a486ff2a5dd18c39ea4b4fc972c819dd9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0f553d34f17c13a1eb3c02e96c983f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#af0f553d34f17c13a1eb3c02e96c983f0">sbservices_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> *client, const char *label)</td></tr>
- <tr class="memdesc:af0f553d34f17c13a1eb3c02e96c983f0"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new sbservices service on the specified device and connects to it. <a href="#af0f553d34f17c13a1eb3c02e96c983f0">More...</a><br /></td></tr>
- <tr class="separator:af0f553d34f17c13a1eb3c02e96c983f0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7780692fbb6730541acf8ce2d054641f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a7780692fbb6730541acf8ce2d054641f">sbservices_client_free</a> (<a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> client)</td></tr>
- <tr class="memdesc:a7780692fbb6730541acf8ce2d054641f"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects an sbservices client from the device and frees up the sbservices client data. <a href="#a7780692fbb6730541acf8ce2d054641f">More...</a><br /></td></tr>
- <tr class="separator:a7780692fbb6730541acf8ce2d054641f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af46584eb04ec7e47b92a8fc972a770c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#af46584eb04ec7e47b92a8fc972a770c1">sbservices_get_icon_state</a> (<a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, plist_t *state, const char *format_version)</td></tr>
- <tr class="memdesc:af46584eb04ec7e47b92a8fc972a770c1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the icon state of the connected device. <a href="#af46584eb04ec7e47b92a8fc972a770c1">More...</a><br /></td></tr>
- <tr class="separator:af46584eb04ec7e47b92a8fc972a770c1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09e3a408b178dde88c3c7392fa26af38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a09e3a408b178dde88c3c7392fa26af38">sbservices_set_icon_state</a> (<a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, plist_t newstate)</td></tr>
- <tr class="memdesc:a09e3a408b178dde88c3c7392fa26af38"><td class="mdescLeft"> </td><td class="mdescRight">Sets the icon state of the connected device. <a href="#a09e3a408b178dde88c3c7392fa26af38">More...</a><br /></td></tr>
- <tr class="separator:a09e3a408b178dde88c3c7392fa26af38"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a54afc804c24a74cec55aa1ac50ec1260"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a54afc804c24a74cec55aa1ac50ec1260">sbservices_get_icon_pngdata</a> (<a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, const char *bundleId, char **pngdata, uint64_t *pngsize)</td></tr>
- <tr class="memdesc:a54afc804c24a74cec55aa1ac50ec1260"><td class="mdescLeft"> </td><td class="mdescRight">Get the icon of the specified app as PNG data. <a href="#a54afc804c24a74cec55aa1ac50ec1260">More...</a><br /></td></tr>
- <tr class="separator:a54afc804c24a74cec55aa1ac50ec1260"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a626f83ee79a9a1a811aff40cdaf17f21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#a626f83ee79a9a1a811aff40cdaf17f21">sbservices_get_interface_orientation</a> (<a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, sbservices_interface_orientation_t *interface_orientation)</td></tr>
- <tr class="memdesc:a626f83ee79a9a1a811aff40cdaf17f21"><td class="mdescLeft"> </td><td class="mdescRight">Gets the interface orientation of the device. <a href="#a626f83ee79a9a1a811aff40cdaf17f21">More...</a><br /></td></tr>
- <tr class="separator:a626f83ee79a9a1a811aff40cdaf17f21"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad9e7f78459d7c4fc8030bb880155e77e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbservices_8h.html#ad9e7f78459d7c4fc8030bb880155e77e">sbservices_get_home_screen_wallpaper_pngdata</a> (<a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> client, char **pngdata, uint64_t *pngsize)</td></tr>
- <tr class="memdesc:ad9e7f78459d7c4fc8030bb880155e77e"><td class="mdescLeft"> </td><td class="mdescRight">Get the home screen wallpaper as PNG data. <a href="#ad9e7f78459d7c4fc8030bb880155e77e">More...</a><br /></td></tr>
- <tr class="separator:ad9e7f78459d7c4fc8030bb880155e77e"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- Orientation of the user interface on the device</h2></td></tr>
- <tr class="memitem:a67262e8f656b7753fb51401a83f0e786"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67262e8f656b7753fb51401a83f0e786"></a>enum  </td><td class="memItemRight" valign="bottom"><b>sbservices_interface_orientation_t</b> { <br />
-   <b>SBSERVICES_INTERFACE_ORIENTATION_UNKNOWN</b> = 0,
- <br />
-   <b>SBSERVICES_INTERFACE_ORIENTATION_PORTRAIT</b> = 1,
- <br />
-   <b>SBSERVICES_INTERFACE_ORIENTATION_PORTRAIT_UPSIDE_DOWN</b> = 2,
- <br />
-   <b>SBSERVICES_INTERFACE_ORIENTATION_LANDSCAPE_RIGHT</b> = 3,
- <br />
-   <b>SBSERVICES_INTERFACE_ORIENTATION_LANDSCAPE_LEFT</b> = 4
- <br />
- }</td></tr>
- <tr class="separator:a67262e8f656b7753fb51401a83f0e786"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Manage SpringBoard icons and retrieve icon images. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a231d40509606f271317474df92d05ca7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef sbservices_client_private* <a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The client handle. </p>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="a7780692fbb6730541acf8ce2d054641f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">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 class="params"><dt>Parameters</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="section return"><dt>Returns</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="a486ff2a5dd18c39ea4b4fc972c819dd9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_client_new </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">lockdownd_service_descriptor_t </td>
- <td class="paramname"><em>service</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">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 class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">service</td><td>The service descriptor returned 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="section return"><dt>Returns</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="af0f553d34f17c13a1eb3c02e96c983f0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_client_start_service </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">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>label</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts a new sbservices service on the specified device and connects to it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated sbservices_client_t upon successful return. Must be freed using <a class="el" href="sbservices_8h.html#a7780692fbb6730541acf8ce2d054641f" title="Disconnects an sbservices client from the device and frees up the sbservices client data...">sbservices_client_free()</a> after use. </td></tr>
- <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>SBSERVICES_E_SUCCESS on success, or an SBSERVICES_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad9e7f78459d7c4fc8030bb880155e77e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_get_home_screen_wallpaper_pngdata </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> </td>
- <td class="paramname"><em>client</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 home screen wallpaper as PNG data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected sbservices client to use. </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="section return"><dt>Returns</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>
- </div>
- </div>
- <a class="anchor" id="a54afc804c24a74cec55aa1ac50ec1260"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_get_icon_pngdata </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">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 class="params"><dt>Parameters</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="section return"><dt>Returns</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="af46584eb04ec7e47b92a8fc972a770c1"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_get_icon_state </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">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 class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>format_version</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 class="params"><dt>Parameters</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>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</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="a626f83ee79a9a1a811aff40cdaf17f21"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_get_interface_orientation </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">sbservices_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">sbservices_interface_orientation_t * </td>
- <td class="paramname"><em>interface_orientation</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the interface orientation of the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected sbservices client to use. </td></tr>
- <tr><td class="paramname">interface_orientation</td><td>The interface orientation upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</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>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="sbservices_8h.html#a43ade5690c1a32fd0ca8e370c9e7b7cc">sbservices_error_t</a> sbservices_set_icon_state </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="sbservices_8h.html#a231d40509606f271317474df92d05ca7">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 class="params"><dt>Parameters</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="section return"><dt>Returns</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><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.8
- </small></address>
- </body>
- </html>
|