libimobiledevice_8h.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731
  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"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>libimobiledevice: libimobiledevice/libimobiledevice.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">libimobiledevice
  21. &#160;<span id="projectnumber">1.2.0</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  34. <li class="current"><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="files.html"><span>File&#160;List</span></a></li>
  40. <li><a href="globals.html"><span>Globals</span></a></li>
  41. </ul>
  42. </div>
  43. <div id="nav-path" class="navpath">
  44. <ul>
  45. <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
  46. </div>
  47. </div><!-- top -->
  48. <div class="header">
  49. <div class="summary">
  50. <a href="#nested-classes">Data Structures</a> &#124;
  51. <a href="#typedef-members">Typedefs</a> &#124;
  52. <a href="#enum-members">Enumerations</a> &#124;
  53. <a href="#func-members">Functions</a> </div>
  54. <div class="headertitle">
  55. <div class="title">libimobiledevice.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Device/Connection handling and communication.
  59. <a href="#details">More...</a></p>
  60. <table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  62. Data Structures</h2></td></tr>
  63. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structidevice__event__t.html">idevice_event_t</a></td></tr>
  64. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides information about the occured event. <a href="structidevice__event__t.html#details">More...</a><br /></td></tr>
  65. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table><table class="memberdecls">
  67. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  68. Typedefs</h2></td></tr>
  69. <tr class="memitem:a682b42e89dc95bd942d0acb7a80993e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a682b42e89dc95bd942d0acb7a80993e5"></a>
  70. typedef struct idevice_private&#160;</td><td class="memItemRight" valign="bottom"><b>idevice_private</b></td></tr>
  71. <tr class="separator:a682b42e89dc95bd942d0acb7a80993e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ae5bc0e9aa2f3b5023755f5e1c5039a60"><td class="memItemLeft" align="right" valign="top">typedef idevice_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a></td></tr>
  73. <tr class="memdesc:ae5bc0e9aa2f3b5023755f5e1c5039a60"><td class="mdescLeft">&#160;</td><td class="mdescRight">The device handle. <a href="#ae5bc0e9aa2f3b5023755f5e1c5039a60">More...</a><br /></td></tr>
  74. <tr class="separator:ae5bc0e9aa2f3b5023755f5e1c5039a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a38581040def08532e17522317d19678b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38581040def08532e17522317d19678b"></a>
  76. typedef struct <br class="typebreak" />
  77. idevice_connection_private&#160;</td><td class="memItemRight" valign="bottom"><b>idevice_connection_private</b></td></tr>
  78. <tr class="separator:a38581040def08532e17522317d19678b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a01e577b2574f08fb2f252607e274ba1b"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  80. idevice_connection_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a></td></tr>
  81. <tr class="memdesc:a01e577b2574f08fb2f252607e274ba1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The connection handle. <a href="#a01e577b2574f08fb2f252607e274ba1b">More...</a><br /></td></tr>
  82. <tr class="separator:a01e577b2574f08fb2f252607e274ba1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aad94d91260a90c2bfad72f1ce8ad1dfd"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#aad94d91260a90c2bfad72f1ce8ad1dfd">idevice_event_cb_t</a> )(const <a class="el" href="structidevice__event__t.html">idevice_event_t</a> *event, void *user_data)</td></tr>
  84. <tr class="memdesc:aad94d91260a90c2bfad72f1ce8ad1dfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to notifiy if a device was added or removed. <a href="#aad94d91260a90c2bfad72f1ce8ad1dfd">More...</a><br /></td></tr>
  85. <tr class="separator:aad94d91260a90c2bfad72f1ce8ad1dfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  88. Enumerations</h2></td></tr>
  89. <tr class="memitem:af8700e72c67d927a6a9ec7688fe87c1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8700e72c67d927a6a9ec7688fe87c1f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> { <br />
  90. &#160;&#160;<b>IDEVICE_E_SUCCESS</b> = 0,
  91. <br />
  92. &#160;&#160;<b>IDEVICE_E_INVALID_ARG</b> = -1,
  93. <br />
  94. &#160;&#160;<b>IDEVICE_E_UNKNOWN_ERROR</b> = -2,
  95. <br />
  96. &#160;&#160;<b>IDEVICE_E_NO_DEVICE</b> = -3,
  97. <br />
  98. &#160;&#160;<b>IDEVICE_E_NOT_ENOUGH_DATA</b> = -4,
  99. <br />
  100. &#160;&#160;<b>IDEVICE_E_BAD_HEADER</b> = -5,
  101. <br />
  102. &#160;&#160;<b>IDEVICE_E_SSL_ERROR</b> = -6
  103. <br />
  104. }</td></tr>
  105. <tr class="memdesc:af8700e72c67d927a6a9ec7688fe87c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  106. <tr class="separator:af8700e72c67d927a6a9ec7688fe87c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:af71b326f7e0b62d61be32f02c620d8d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af71b326f7e0b62d61be32f02c620d8d9"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#af71b326f7e0b62d61be32f02c620d8d9">idevice_event_type</a> { <br />
  108. &#160;&#160;<b>IDEVICE_DEVICE_ADD</b> = 1,
  109. <br />
  110. &#160;&#160;<b>IDEVICE_DEVICE_REMOVE</b>
  111. <br />
  112. }</td></tr>
  113. <tr class="memdesc:af71b326f7e0b62d61be32f02c620d8d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The event type for device add or removal. <br /></td></tr>
  114. <tr class="separator:af71b326f7e0b62d61be32f02c620d8d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  117. Functions</h2></td></tr>
  118. <tr class="memitem:aa7ff5b795b752bd2086f433317ccc32a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#aa7ff5b795b752bd2086f433317ccc32a">idevice_set_debug_level</a> (int level)</td></tr>
  119. <tr class="memdesc:aa7ff5b795b752bd2086f433317ccc32a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the level of debugging. <a href="#aa7ff5b795b752bd2086f433317ccc32a">More...</a><br /></td></tr>
  120. <tr class="separator:aa7ff5b795b752bd2086f433317ccc32a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ae3be327d9198b7a7071b709866cfd670"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#ae3be327d9198b7a7071b709866cfd670">idevice_event_subscribe</a> (<a class="el" href="libimobiledevice_8h.html#aad94d91260a90c2bfad72f1ce8ad1dfd">idevice_event_cb_t</a> callback, void *user_data)</td></tr>
  122. <tr class="memdesc:ae3be327d9198b7a7071b709866cfd670"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a callback function that will be called when device add/remove events occur. <a href="#ae3be327d9198b7a7071b709866cfd670">More...</a><br /></td></tr>
  123. <tr class="separator:ae3be327d9198b7a7071b709866cfd670"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aa5f7bdf4e79185e64391eb8503c5a7e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#aa5f7bdf4e79185e64391eb8503c5a7e2">idevice_event_unsubscribe</a> (void)</td></tr>
  125. <tr class="memdesc:aa5f7bdf4e79185e64391eb8503c5a7e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the event callback function that has been registered with <a class="el" href="libimobiledevice_8h.html#ae3be327d9198b7a7071b709866cfd670" title="Register a callback function that will be called when device add/remove events occur. ">idevice_event_subscribe()</a>. <a href="#aa5f7bdf4e79185e64391eb8503c5a7e2">More...</a><br /></td></tr>
  126. <tr class="separator:aa5f7bdf4e79185e64391eb8503c5a7e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:af4d17b7a056088f366967f2f13f0700b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#af4d17b7a056088f366967f2f13f0700b">idevice_get_device_list</a> (char ***devices, int *count)</td></tr>
  128. <tr class="memdesc:af4d17b7a056088f366967f2f13f0700b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a list of currently available devices. <a href="#af4d17b7a056088f366967f2f13f0700b">More...</a><br /></td></tr>
  129. <tr class="separator:af4d17b7a056088f366967f2f13f0700b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a22f6dd94a426ef0bb01e2a48a0dc76e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a22f6dd94a426ef0bb01e2a48a0dc76e2">idevice_device_list_free</a> (char **devices)</td></tr>
  131. <tr class="memdesc:a22f6dd94a426ef0bb01e2a48a0dc76e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a list of device udids. <a href="#a22f6dd94a426ef0bb01e2a48a0dc76e2">More...</a><br /></td></tr>
  132. <tr class="separator:a22f6dd94a426ef0bb01e2a48a0dc76e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a8d4357398040c3b0bd34c6472cec0785"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a8d4357398040c3b0bd34c6472cec0785">idevice_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> *device, const char *udid)</td></tr>
  134. <tr class="memdesc:a8d4357398040c3b0bd34c6472cec0785"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an idevice_t structure for the device specified by udid, if the device is available. <a href="#a8d4357398040c3b0bd34c6472cec0785">More...</a><br /></td></tr>
  135. <tr class="separator:a8d4357398040c3b0bd34c6472cec0785"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a98caab570c77156838829f760560f81a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a98caab570c77156838829f760560f81a">idevice_free</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device)</td></tr>
  137. <tr class="memdesc:a98caab570c77156838829f760560f81a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleans up an idevice structure, then frees the structure itself. <a href="#a98caab570c77156838829f760560f81a">More...</a><br /></td></tr>
  138. <tr class="separator:a98caab570c77156838829f760560f81a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a487774a7f9ae8f617cbe7f8eef68596b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a487774a7f9ae8f617cbe7f8eef68596b">idevice_connect</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, uint16_t port, <a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *connection)</td></tr>
  140. <tr class="memdesc:a487774a7f9ae8f617cbe7f8eef68596b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set up a connection to the given device. <a href="#a487774a7f9ae8f617cbe7f8eef68596b">More...</a><br /></td></tr>
  141. <tr class="separator:a487774a7f9ae8f617cbe7f8eef68596b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a3744a4f4c4655ae9c12c373dc58ac144"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a3744a4f4c4655ae9c12c373dc58ac144">idevice_disconnect</a> (<a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> connection)</td></tr>
  143. <tr class="memdesc:a3744a4f4c4655ae9c12c373dc58ac144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect from the device and clean up the connection structure. <a href="#a3744a4f4c4655ae9c12c373dc58ac144">More...</a><br /></td></tr>
  144. <tr class="separator:a3744a4f4c4655ae9c12c373dc58ac144"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a2bf12d601c1f1744e479a3fd379f5b0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a2bf12d601c1f1744e479a3fd379f5b0c">idevice_connection_send</a> (<a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> connection, const char *data, uint32_t len, uint32_t *sent_bytes)</td></tr>
  146. <tr class="memdesc:a2bf12d601c1f1744e479a3fd379f5b0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send data to a device via the given connection. <a href="#a2bf12d601c1f1744e479a3fd379f5b0c">More...</a><br /></td></tr>
  147. <tr class="separator:a2bf12d601c1f1744e479a3fd379f5b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a8e243f912679771b7b12ff93758c9d4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a8e243f912679771b7b12ff93758c9d4b">idevice_connection_receive_timeout</a> (<a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> connection, char *data, uint32_t len, uint32_t *recv_bytes, unsigned int timeout)</td></tr>
  149. <tr class="memdesc:a8e243f912679771b7b12ff93758c9d4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive data from a device via the given connection. <a href="#a8e243f912679771b7b12ff93758c9d4b">More...</a><br /></td></tr>
  150. <tr class="separator:a8e243f912679771b7b12ff93758c9d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a0f40ec458db4f77449f67e41bd14170d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a0f40ec458db4f77449f67e41bd14170d">idevice_connection_receive</a> (<a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> connection, char *data, uint32_t len, uint32_t *recv_bytes)</td></tr>
  152. <tr class="memdesc:a0f40ec458db4f77449f67e41bd14170d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive data from a device via the given connection. <a href="#a0f40ec458db4f77449f67e41bd14170d">More...</a><br /></td></tr>
  153. <tr class="separator:a0f40ec458db4f77449f67e41bd14170d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ac10ce034352faa0fc3fa55b8c78f2781"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#ac10ce034352faa0fc3fa55b8c78f2781">idevice_connection_enable_ssl</a> (<a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> connection)</td></tr>
  155. <tr class="memdesc:ac10ce034352faa0fc3fa55b8c78f2781"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables SSL for the given connection. <a href="#ac10ce034352faa0fc3fa55b8c78f2781">More...</a><br /></td></tr>
  156. <tr class="separator:ac10ce034352faa0fc3fa55b8c78f2781"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:ae9f1b29ea7fb3b819f29541d773d2761"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#ae9f1b29ea7fb3b819f29541d773d2761">idevice_connection_disable_ssl</a> (<a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> connection)</td></tr>
  158. <tr class="memdesc:ae9f1b29ea7fb3b819f29541d773d2761"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable SSL for the given connection. <a href="#ae9f1b29ea7fb3b819f29541d773d2761">More...</a><br /></td></tr>
  159. <tr class="separator:ae9f1b29ea7fb3b819f29541d773d2761"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a15a523978dd85aece5c28efa961a63fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#a15a523978dd85aece5c28efa961a63fe">idevice_get_handle</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, uint32_t *handle)</td></tr>
  161. <tr class="memdesc:a15a523978dd85aece5c28efa961a63fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the handle of the device. <a href="#a15a523978dd85aece5c28efa961a63fe">More...</a><br /></td></tr>
  162. <tr class="separator:a15a523978dd85aece5c28efa961a63fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:ace2002ede2daea10f848729f6ee2dc85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace2002ede2daea10f848729f6ee2dc85"></a>
  164. <a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libimobiledevice_8h.html#ace2002ede2daea10f848729f6ee2dc85">idevice_get_udid</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, char **udid)</td></tr>
  165. <tr class="memdesc:ace2002ede2daea10f848729f6ee2dc85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the unique id for the device. <br /></td></tr>
  166. <tr class="separator:ace2002ede2daea10f848729f6ee2dc85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  169. <div class="textblock"><p>Device/Connection handling and communication. </p>
  170. </div><h2 class="groupheader">Typedef Documentation</h2>
  171. <a class="anchor" id="a01e577b2574f08fb2f252607e274ba1b"></a>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">typedef idevice_connection_private* <a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>The connection handle. </p>
  181. </div>
  182. </div>
  183. <a class="anchor" id="aad94d91260a90c2bfad72f1ce8ad1dfd"></a>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">typedef void(* idevice_event_cb_t)(const <a class="el" href="structidevice__event__t.html">idevice_event_t</a> *event, void *user_data)</td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Callback to notifiy if a device was added or removed. </p>
  193. </div>
  194. </div>
  195. <a class="anchor" id="ae5bc0e9aa2f3b5023755f5e1c5039a60"></a>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">typedef idevice_private* <a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>The device handle. </p>
  205. </div>
  206. </div>
  207. <h2 class="groupheader">Function Documentation</h2>
  208. <a class="anchor" id="a487774a7f9ae8f617cbe7f8eef68596b"></a>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_connect </td>
  214. <td>(</td>
  215. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  216. <td class="paramname"><em>device</em>, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">uint16_t&#160;</td>
  222. <td class="paramname"><em>port</em>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *&#160;</td>
  228. <td class="paramname"><em>connection</em>&#160;</td>
  229. </tr>
  230. <tr>
  231. <td></td>
  232. <td>)</td>
  233. <td></td><td></td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Set up a connection to the given device. </p>
  238. <dl class="params"><dt>Parameters</dt><dd>
  239. <table class="params">
  240. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  241. <tr><td class="paramname">port</td><td>The destination port to connect to. </td></tr>
  242. <tr><td class="paramname">connection</td><td>Pointer to an idevice_connection_t that will be filled with the necessary data of the connection.</td></tr>
  243. </table>
  244. </dd>
  245. </dl>
  246. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS if ok, otherwise an error code. </dd></dl>
  247. </div>
  248. </div>
  249. <a class="anchor" id="ae9f1b29ea7fb3b819f29541d773d2761"></a>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_connection_disable_ssl </td>
  255. <td>(</td>
  256. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a>&#160;</td>
  257. <td class="paramname"><em>connection</em></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Disable SSL for the given connection. </p>
  263. <dl class="params"><dt>Parameters</dt><dd>
  264. <table class="params">
  265. <tr><td class="paramname">connection</td><td>The connection to disable SSL for.</td></tr>
  266. </table>
  267. </dd>
  268. </dl>
  269. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS on success, IDEVICE_E_INVALID_ARG when connection is NULL. This function also returns IDEVICE_E_SUCCESS when SSL is not enabled and does no further error checking on cleanup. </dd></dl>
  270. </div>
  271. </div>
  272. <a class="anchor" id="ac10ce034352faa0fc3fa55b8c78f2781"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_connection_enable_ssl </td>
  278. <td>(</td>
  279. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a>&#160;</td>
  280. <td class="paramname"><em>connection</em></td><td>)</td>
  281. <td></td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. <p>Enables SSL for the given connection. </p>
  286. <dl class="params"><dt>Parameters</dt><dd>
  287. <table class="params">
  288. <tr><td class="paramname">connection</td><td>The connection to enable SSL for.</td></tr>
  289. </table>
  290. </dd>
  291. </dl>
  292. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS on success, IDEVICE_E_INVALID_ARG when connection is NULL or connection-&gt;ssl_data is non-NULL, or IDEVICE_E_SSL_ERROR when SSL initialization, setup, or handshake fails. </dd></dl>
  293. </div>
  294. </div>
  295. <a class="anchor" id="a0f40ec458db4f77449f67e41bd14170d"></a>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_connection_receive </td>
  301. <td>(</td>
  302. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a>&#160;</td>
  303. <td class="paramname"><em>connection</em>, </td>
  304. </tr>
  305. <tr>
  306. <td class="paramkey"></td>
  307. <td></td>
  308. <td class="paramtype">char *&#160;</td>
  309. <td class="paramname"><em>data</em>, </td>
  310. </tr>
  311. <tr>
  312. <td class="paramkey"></td>
  313. <td></td>
  314. <td class="paramtype">uint32_t&#160;</td>
  315. <td class="paramname"><em>len</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">uint32_t *&#160;</td>
  321. <td class="paramname"><em>recv_bytes</em>&#160;</td>
  322. </tr>
  323. <tr>
  324. <td></td>
  325. <td>)</td>
  326. <td></td><td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Receive data from a device via the given connection. </p>
  331. <p>This function is like idevice_connection_receive_timeout, but with a predefined reasonable timeout.</p>
  332. <dl class="params"><dt>Parameters</dt><dd>
  333. <table class="params">
  334. <tr><td class="paramname">connection</td><td>The connection to receive data from. </td></tr>
  335. <tr><td class="paramname">data</td><td>Buffer that will be filled with the received data. This buffer has to be large enough to hold len bytes. </td></tr>
  336. <tr><td class="paramname">len</td><td>Buffer size or number of bytes to receive. </td></tr>
  337. <tr><td class="paramname">recv_bytes</td><td>Number of bytes actually received.</td></tr>
  338. </table>
  339. </dd>
  340. </dl>
  341. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS if ok, otherwise an error code. </dd></dl>
  342. </div>
  343. </div>
  344. <a class="anchor" id="a8e243f912679771b7b12ff93758c9d4b"></a>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_connection_receive_timeout </td>
  350. <td>(</td>
  351. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a>&#160;</td>
  352. <td class="paramname"><em>connection</em>, </td>
  353. </tr>
  354. <tr>
  355. <td class="paramkey"></td>
  356. <td></td>
  357. <td class="paramtype">char *&#160;</td>
  358. <td class="paramname"><em>data</em>, </td>
  359. </tr>
  360. <tr>
  361. <td class="paramkey"></td>
  362. <td></td>
  363. <td class="paramtype">uint32_t&#160;</td>
  364. <td class="paramname"><em>len</em>, </td>
  365. </tr>
  366. <tr>
  367. <td class="paramkey"></td>
  368. <td></td>
  369. <td class="paramtype">uint32_t *&#160;</td>
  370. <td class="paramname"><em>recv_bytes</em>, </td>
  371. </tr>
  372. <tr>
  373. <td class="paramkey"></td>
  374. <td></td>
  375. <td class="paramtype">unsigned int&#160;</td>
  376. <td class="paramname"><em>timeout</em>&#160;</td>
  377. </tr>
  378. <tr>
  379. <td></td>
  380. <td>)</td>
  381. <td></td><td></td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Receive data from a device via the given connection. </p>
  386. <p>This function will return after the given timeout even if no data has been received.</p>
  387. <dl class="params"><dt>Parameters</dt><dd>
  388. <table class="params">
  389. <tr><td class="paramname">connection</td><td>The connection to receive data from. </td></tr>
  390. <tr><td class="paramname">data</td><td>Buffer that will be filled with the received data. This buffer has to be large enough to hold len bytes. </td></tr>
  391. <tr><td class="paramname">len</td><td>Buffer size or number of bytes to receive. </td></tr>
  392. <tr><td class="paramname">recv_bytes</td><td>Number of bytes actually received. </td></tr>
  393. <tr><td class="paramname">timeout</td><td>Timeout in milliseconds after which this function should return even if no data has been received.</td></tr>
  394. </table>
  395. </dd>
  396. </dl>
  397. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS if ok, otherwise an error code. </dd></dl>
  398. </div>
  399. </div>
  400. <a class="anchor" id="a2bf12d601c1f1744e479a3fd379f5b0c"></a>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_connection_send </td>
  406. <td>(</td>
  407. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a>&#160;</td>
  408. <td class="paramname"><em>connection</em>, </td>
  409. </tr>
  410. <tr>
  411. <td class="paramkey"></td>
  412. <td></td>
  413. <td class="paramtype">const char *&#160;</td>
  414. <td class="paramname"><em>data</em>, </td>
  415. </tr>
  416. <tr>
  417. <td class="paramkey"></td>
  418. <td></td>
  419. <td class="paramtype">uint32_t&#160;</td>
  420. <td class="paramname"><em>len</em>, </td>
  421. </tr>
  422. <tr>
  423. <td class="paramkey"></td>
  424. <td></td>
  425. <td class="paramtype">uint32_t *&#160;</td>
  426. <td class="paramname"><em>sent_bytes</em>&#160;</td>
  427. </tr>
  428. <tr>
  429. <td></td>
  430. <td>)</td>
  431. <td></td><td></td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Send data to a device via the given connection. </p>
  436. <dl class="params"><dt>Parameters</dt><dd>
  437. <table class="params">
  438. <tr><td class="paramname">connection</td><td>The connection to send data over. </td></tr>
  439. <tr><td class="paramname">data</td><td>Buffer with data to send. </td></tr>
  440. <tr><td class="paramname">len</td><td>Size of the buffer to send. </td></tr>
  441. <tr><td class="paramname">sent_bytes</td><td>Pointer to an uint32_t that will be filled with the number of bytes actually sent.</td></tr>
  442. </table>
  443. </dd>
  444. </dl>
  445. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS if ok, otherwise an error code. </dd></dl>
  446. </div>
  447. </div>
  448. <a class="anchor" id="a22f6dd94a426ef0bb01e2a48a0dc76e2"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_device_list_free </td>
  454. <td>(</td>
  455. <td class="paramtype">char **&#160;</td>
  456. <td class="paramname"><em>devices</em></td><td>)</td>
  457. <td></td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Free a list of device udids. </p>
  462. <dl class="params"><dt>Parameters</dt><dd>
  463. <table class="params">
  464. <tr><td class="paramname">devices</td><td>List of udids to free.</td></tr>
  465. </table>
  466. </dd>
  467. </dl>
  468. <dl class="section return"><dt>Returns</dt><dd>Always returnes IDEVICE_E_SUCCESS. </dd></dl>
  469. </div>
  470. </div>
  471. <a class="anchor" id="a3744a4f4c4655ae9c12c373dc58ac144"></a>
  472. <div class="memitem">
  473. <div class="memproto">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_disconnect </td>
  477. <td>(</td>
  478. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a>&#160;</td>
  479. <td class="paramname"><em>connection</em></td><td>)</td>
  480. <td></td>
  481. </tr>
  482. </table>
  483. </div><div class="memdoc">
  484. <p>Disconnect from the device and clean up the connection structure. </p>
  485. <dl class="params"><dt>Parameters</dt><dd>
  486. <table class="params">
  487. <tr><td class="paramname">connection</td><td>The connection to close.</td></tr>
  488. </table>
  489. </dd>
  490. </dl>
  491. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS if ok, otherwise an error code. </dd></dl>
  492. </div>
  493. </div>
  494. <a class="anchor" id="ae3be327d9198b7a7071b709866cfd670"></a>
  495. <div class="memitem">
  496. <div class="memproto">
  497. <table class="memname">
  498. <tr>
  499. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_event_subscribe </td>
  500. <td>(</td>
  501. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#aad94d91260a90c2bfad72f1ce8ad1dfd">idevice_event_cb_t</a>&#160;</td>
  502. <td class="paramname"><em>callback</em>, </td>
  503. </tr>
  504. <tr>
  505. <td class="paramkey"></td>
  506. <td></td>
  507. <td class="paramtype">void *&#160;</td>
  508. <td class="paramname"><em>user_data</em>&#160;</td>
  509. </tr>
  510. <tr>
  511. <td></td>
  512. <td>)</td>
  513. <td></td><td></td>
  514. </tr>
  515. </table>
  516. </div><div class="memdoc">
  517. <p>Register a callback function that will be called when device add/remove events occur. </p>
  518. <dl class="params"><dt>Parameters</dt><dd>
  519. <table class="params">
  520. <tr><td class="paramname">callback</td><td>Callback function to call. </td></tr>
  521. <tr><td class="paramname">user_data</td><td>Application-specific data passed as parameter to the registered callback function.</td></tr>
  522. </table>
  523. </dd>
  524. </dl>
  525. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS on success or an error value when an error occured. </dd></dl>
  526. </div>
  527. </div>
  528. <a class="anchor" id="aa5f7bdf4e79185e64391eb8503c5a7e2"></a>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_event_unsubscribe </td>
  534. <td>(</td>
  535. <td class="paramtype">void&#160;</td>
  536. <td class="paramname"></td><td>)</td>
  537. <td></td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>Release the event callback function that has been registered with <a class="el" href="libimobiledevice_8h.html#ae3be327d9198b7a7071b709866cfd670" title="Register a callback function that will be called when device add/remove events occur. ">idevice_event_subscribe()</a>. </p>
  542. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS on success or an error value when an error occured. </dd></dl>
  543. </div>
  544. </div>
  545. <a class="anchor" id="a98caab570c77156838829f760560f81a"></a>
  546. <div class="memitem">
  547. <div class="memproto">
  548. <table class="memname">
  549. <tr>
  550. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_free </td>
  551. <td>(</td>
  552. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  553. <td class="paramname"><em>device</em></td><td>)</td>
  554. <td></td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. <p>Cleans up an idevice structure, then frees the structure itself. </p>
  559. <p>This is a library-level function; deals directly with the device to tear down relations, but otherwise is mostly internal.</p>
  560. <dl class="params"><dt>Parameters</dt><dd>
  561. <table class="params">
  562. <tr><td class="paramname">device</td><td>idevice_t to free. </td></tr>
  563. </table>
  564. </dd>
  565. </dl>
  566. </div>
  567. </div>
  568. <a class="anchor" id="af4d17b7a056088f366967f2f13f0700b"></a>
  569. <div class="memitem">
  570. <div class="memproto">
  571. <table class="memname">
  572. <tr>
  573. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_get_device_list </td>
  574. <td>(</td>
  575. <td class="paramtype">char ***&#160;</td>
  576. <td class="paramname"><em>devices</em>, </td>
  577. </tr>
  578. <tr>
  579. <td class="paramkey"></td>
  580. <td></td>
  581. <td class="paramtype">int *&#160;</td>
  582. <td class="paramname"><em>count</em>&#160;</td>
  583. </tr>
  584. <tr>
  585. <td></td>
  586. <td>)</td>
  587. <td></td><td></td>
  588. </tr>
  589. </table>
  590. </div><div class="memdoc">
  591. <p>Get a list of currently available devices. </p>
  592. <dl class="params"><dt>Parameters</dt><dd>
  593. <table class="params">
  594. <tr><td class="paramname">devices</td><td>List of udids of devices that are currently available. This list is terminated by a NULL pointer. </td></tr>
  595. <tr><td class="paramname">count</td><td>Number of devices found.</td></tr>
  596. </table>
  597. </dd>
  598. </dl>
  599. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS on success or an error value when an error occured. </dd></dl>
  600. </div>
  601. </div>
  602. <a class="anchor" id="a15a523978dd85aece5c28efa961a63fe"></a>
  603. <div class="memitem">
  604. <div class="memproto">
  605. <table class="memname">
  606. <tr>
  607. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_get_handle </td>
  608. <td>(</td>
  609. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  610. <td class="paramname"><em>device</em>, </td>
  611. </tr>
  612. <tr>
  613. <td class="paramkey"></td>
  614. <td></td>
  615. <td class="paramtype">uint32_t *&#160;</td>
  616. <td class="paramname"><em>handle</em>&#160;</td>
  617. </tr>
  618. <tr>
  619. <td></td>
  620. <td>)</td>
  621. <td></td><td></td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <p>Gets the handle of the device. </p>
  626. <p>Depends on the connection type. </p>
  627. </div>
  628. </div>
  629. <a class="anchor" id="a8d4357398040c3b0bd34c6472cec0785"></a>
  630. <div class="memitem">
  631. <div class="memproto">
  632. <table class="memname">
  633. <tr>
  634. <td class="memname"><a class="el" href="libimobiledevice_8h.html#af8700e72c67d927a6a9ec7688fe87c1f">idevice_error_t</a> idevice_new </td>
  635. <td>(</td>
  636. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> *&#160;</td>
  637. <td class="paramname"><em>device</em>, </td>
  638. </tr>
  639. <tr>
  640. <td class="paramkey"></td>
  641. <td></td>
  642. <td class="paramtype">const char *&#160;</td>
  643. <td class="paramname"><em>udid</em>&#160;</td>
  644. </tr>
  645. <tr>
  646. <td></td>
  647. <td>)</td>
  648. <td></td><td></td>
  649. </tr>
  650. </table>
  651. </div><div class="memdoc">
  652. <p>Creates an idevice_t structure for the device specified by udid, if the device is available. </p>
  653. <dl class="section note"><dt>Note</dt><dd>The resulting idevice_t structure has to be freed with <a class="el" href="libimobiledevice_8h.html#a98caab570c77156838829f760560f81a" title="Cleans up an idevice structure, then frees the structure itself. ">idevice_free()</a> if it is no longer used.</dd></dl>
  654. <dl class="params"><dt>Parameters</dt><dd>
  655. <table class="params">
  656. <tr><td class="paramname">device</td><td>Upon calling this function, a pointer to a location of type idevice_t. On successful return, this location will be populated. </td></tr>
  657. <tr><td class="paramname">udid</td><td>The UDID to match.</td></tr>
  658. </table>
  659. </dd>
  660. </dl>
  661. <dl class="section return"><dt>Returns</dt><dd>IDEVICE_E_SUCCESS if ok, otherwise an error code. </dd></dl>
  662. </div>
  663. </div>
  664. <a class="anchor" id="aa7ff5b795b752bd2086f433317ccc32a"></a>
  665. <div class="memitem">
  666. <div class="memproto">
  667. <table class="memname">
  668. <tr>
  669. <td class="memname">void idevice_set_debug_level </td>
  670. <td>(</td>
  671. <td class="paramtype">int&#160;</td>
  672. <td class="paramname"><em>level</em></td><td>)</td>
  673. <td></td>
  674. </tr>
  675. </table>
  676. </div><div class="memdoc">
  677. <p>Set the level of debugging. </p>
  678. <dl class="params"><dt>Parameters</dt><dd>
  679. <table class="params">
  680. <tr><td class="paramname">level</td><td>Set to 0 for no debug output or 1 to enable debug output. </td></tr>
  681. </table>
  682. </dd>
  683. </dl>
  684. </div>
  685. </div>
  686. </div><!-- contents -->
  687. <!-- start footer part -->
  688. <hr class="footer"/><address class="footer"><small>
  689. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  690. <img class="footer" src="doxygen.png" alt="doxygen"/>
  691. </a> 1.8.8
  692. </small></address>
  693. </body>
  694. </html>