| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372 |
- <!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/file_relay.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">file_relay.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Retrieve compressed CPIO archives.
- <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:a734d26b64c2b4e4de79ed2a5042d7962"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a734d26b64c2b4e4de79ed2a5042d7962"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>FILE_RELAY_SERVICE_NAME</b>   "com.apple.mobile.file_relay"</td></tr>
- <tr class="separator:a734d26b64c2b4e4de79ed2a5042d7962"><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:a8605235172ab120f2334e1184f03189d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8605235172ab120f2334e1184f03189d"></a>
- typedef struct <br class="typebreak" />
- file_relay_client_private </td><td class="memItemRight" valign="bottom"><b>file_relay_client_private</b></td></tr>
- <tr class="separator:a8605235172ab120f2334e1184f03189d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab3be437eb59c3a5684ee572d554ac044"><td class="memItemLeft" align="right" valign="top">typedef file_relay_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a></td></tr>
- <tr class="memdesc:ab3be437eb59c3a5684ee572d554ac044"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#ab3be437eb59c3a5684ee572d554ac044">More...</a><br /></td></tr>
- <tr class="separator:ab3be437eb59c3a5684ee572d554ac044"><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:a42ebdb0d27b59e9a757e0771a78ff175"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42ebdb0d27b59e9a757e0771a78ff175"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> { <br />
-   <b>FILE_RELAY_E_SUCCESS</b> = 0,
- <br />
-   <b>FILE_RELAY_E_INVALID_ARG</b> = -1,
- <br />
-   <b>FILE_RELAY_E_PLIST_ERROR</b> = -2,
- <br />
-   <b>FILE_RELAY_E_MUX_ERROR</b> = -3,
- <br />
-   <b>FILE_RELAY_E_INVALID_SOURCE</b> = -4,
- <br />
-   <b>FILE_RELAY_E_STAGING_EMPTY</b> = -5,
- <br />
-   <b>FILE_RELAY_E_PERMISSION_DENIED</b> = -6,
- <br />
-   <b>FILE_RELAY_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a42ebdb0d27b59e9a757e0771a78ff175"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a42ebdb0d27b59e9a757e0771a78ff175"><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:ae84497b237b21987a0e7f981d6927a14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#ae84497b237b21987a0e7f981d6927a14">file_relay_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> *client)</td></tr>
- <tr class="memdesc:ae84497b237b21987a0e7f981d6927a14"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the file_relay service on the specified device. <a href="#ae84497b237b21987a0e7f981d6927a14">More...</a><br /></td></tr>
- <tr class="separator:ae84497b237b21987a0e7f981d6927a14"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a53749f92d302587b5d2cee0faeb3a5e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a53749f92d302587b5d2cee0faeb3a5e6">file_relay_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> *client, const char *label)</td></tr>
- <tr class="memdesc:a53749f92d302587b5d2cee0faeb3a5e6"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new file_relay service on the specified device and connects to it. <a href="#a53749f92d302587b5d2cee0faeb3a5e6">More...</a><br /></td></tr>
- <tr class="separator:a53749f92d302587b5d2cee0faeb3a5e6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a505e17a6a1184d65c0cb30119d169d2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b">file_relay_client_free</a> (<a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> client)</td></tr>
- <tr class="memdesc:a505e17a6a1184d65c0cb30119d169d2b"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects a file_relay client from the device and frees up the file_relay client data. <a href="#a505e17a6a1184d65c0cb30119d169d2b">More...</a><br /></td></tr>
- <tr class="separator:a505e17a6a1184d65c0cb30119d169d2b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab96cd1495725dd5adfd65573048cf86f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#ab96cd1495725dd5adfd65573048cf86f">file_relay_request_sources</a> (<a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> client, const char **sources, <a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *connection)</td></tr>
- <tr class="memdesc:ab96cd1495725dd5adfd65573048cf86f"><td class="mdescLeft"> </td><td class="mdescRight">Request data for the given sources. <a href="#ab96cd1495725dd5adfd65573048cf86f">More...</a><br /></td></tr>
- <tr class="separator:ab96cd1495725dd5adfd65573048cf86f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a946893f67f01002e1d0d00609e639ebb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a946893f67f01002e1d0d00609e639ebb">file_relay_request_sources_timeout</a> (<a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> client, const char **sources, <a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *connection, unsigned int timeout)</td></tr>
- <tr class="memdesc:a946893f67f01002e1d0d00609e639ebb"><td class="mdescLeft"> </td><td class="mdescRight">Request data for the given sources. <a href="#a946893f67f01002e1d0d00609e639ebb">More...</a><br /></td></tr>
- <tr class="separator:a946893f67f01002e1d0d00609e639ebb"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Retrieve compressed CPIO archives. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="ab3be437eb59c3a5684ee572d554ac044"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef file_relay_client_private* <a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_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="a505e17a6a1184d65c0cb30119d169d2b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disconnects a file_relay client from the device and frees up the file_relay client data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The file_relay client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on success, FILE_RELAY_E_INVALID_ARG when one of client or client->parent is invalid, or FILE_RELAY_E_UNKNOWN_ERROR when the was an error freeing the parent property_list_service client. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ae84497b237b21987a0e7f981d6927a14"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_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="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_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 file_relay 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>Reference that will point to a newly allocated file_relay_client_t upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on success, FILE_RELAY_E_INVALID_ARG when one of the parameters is invalid, or FILE_RELAY_E_MUX_ERROR when the connection failed. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a53749f92d302587b5d2cee0faeb3a5e6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_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="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_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 file_relay 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 file_relay_client_t upon successful return. Must be freed using <a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b" title="Disconnects a file_relay client from the device and frees up the file_relay client data...">file_relay_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>FILE_RELAY_E_SUCCESS on success, or an FILE_RELAY_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab96cd1495725dd5adfd65573048cf86f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_request_sources </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_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>sources</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> * </td>
- <td class="paramname"><em>connection</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request data for the given sources. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected file_relay client. </td></tr>
- <tr><td class="paramname">sources</td><td>A NULL-terminated list of sources to retrieve. Valid sources are:<ul>
- <li>AppleSupport</li>
- <li>Network</li>
- <li>VPN</li>
- <li>WiFi</li>
- <li>UserDatabases</li>
- <li>CrashReporter</li>
- <li>tmp</li>
- <li>SystemConfiguration </li>
- </ul>
- </td></tr>
- <tr><td class="paramname">connection</td><td>The connection that has to be used for receiving the data using <a class="el" href="libimobiledevice_8h.html#a0f40ec458db4f77449f67e41bd14170d" title="Receive data from a device via the given connection. ">idevice_connection_receive()</a>. The connection will be closed automatically by the device, but use <a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b" title="Disconnects a file_relay client from the device and frees up the file_relay client data...">file_relay_client_free()</a> to clean up properly. </td></tr>
- <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>WARNING: Don't call this function without reading the data afterwards. A directory mobile_file_relay.XXXX used for creating the archive will remain in the /tmp directory otherwise.</dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on succes, FILE_RELAY_E_INVALID_ARG when one or more parameters are invalid, FILE_RELAY_E_MUX_ERROR if a communication error occurs, FILE_RELAY_E_PLIST_ERROR when the received result is NULL or is not a valid plist, FILE_RELAY_E_INVALID_SOURCE if one or more sources are invalid, FILE_RELAY_E_STAGING_EMPTY if no data is available for the given sources, or FILE_RELAY_E_UNKNOWN_ERROR otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a946893f67f01002e1d0d00609e639ebb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_request_sources_timeout </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_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>sources</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> * </td>
- <td class="paramname"><em>connection</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>timeout</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request data for the given sources. </p>
- <p>Calls <a class="el" href="file__relay_8h.html#a946893f67f01002e1d0d00609e639ebb" title="Request data for the given sources. ">file_relay_request_sources_timeout()</a> with a timeout of 60000 milliseconds (60 seconds).</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The connected file_relay client. </td></tr>
- <tr><td class="paramname">sources</td><td>A NULL-terminated list of sources to retrieve. Valid sources are:<ul>
- <li>AppleSupport</li>
- <li>Network</li>
- <li>VPN</li>
- <li>WiFi</li>
- <li>UserDatabases</li>
- <li>CrashReporter</li>
- <li>tmp</li>
- <li>SystemConfiguration </li>
- </ul>
- </td></tr>
- <tr><td class="paramname">connection</td><td>The connection that has to be used for receiving the data using <a class="el" href="libimobiledevice_8h.html#a0f40ec458db4f77449f67e41bd14170d" title="Receive data from a device via the given connection. ">idevice_connection_receive()</a>. The connection will be closed automatically by the device, but use <a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b" title="Disconnects a file_relay client from the device and frees up the file_relay client data...">file_relay_client_free()</a> to clean up properly.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>WARNING: Don't call this function without reading the data afterwards. A directory mobile_file_relay.XXXX used for creating the archive will remain in the /tmp directory otherwise.</dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on succes, FILE_RELAY_E_INVALID_ARG when one or more parameters are invalid, FILE_RELAY_E_MUX_ERROR if a communication error occurs, FILE_RELAY_E_PLIST_ERROR when the received result is NULL or is not a valid plist, FILE_RELAY_E_INVALID_SOURCE if one or more sources are invalid, FILE_RELAY_E_STAGING_EMPTY if no data is available for the given sources, or FILE_RELAY_E_UNKNOWN_ERROR 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>
|