| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305 |
- <!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/afc.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">afc.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Access the filesystem on the device.
- <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:ab4df27e71cd0a40faaf3569c2445421d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4df27e71cd0a40faaf3569c2445421d"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>AFC_SERVICE_NAME</b>   "com.apple.afc"</td></tr>
- <tr class="separator:ab4df27e71cd0a40faaf3569c2445421d"><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:ac1304c050ebd27b1ef5aff41f0483019"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1304c050ebd27b1ef5aff41f0483019"></a>
- typedef struct afc_client_private </td><td class="memItemRight" valign="bottom"><b>afc_client_private</b></td></tr>
- <tr class="separator:ac1304c050ebd27b1ef5aff41f0483019"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a06351ca31179c322c0a5eb4f13296ec7"><td class="memItemLeft" align="right" valign="top">typedef afc_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a></td></tr>
- <tr class="memdesc:a06351ca31179c322c0a5eb4f13296ec7"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a06351ca31179c322c0a5eb4f13296ec7">More...</a><br /></td></tr>
- <tr class="separator:a06351ca31179c322c0a5eb4f13296ec7"><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:a913481f73acbd6026a4663bd7ec3f6c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a913481f73acbd6026a4663bd7ec3f6c9"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> { <br />
-   <b>AFC_E_SUCCESS</b> = 0,
- <br />
-   <b>AFC_E_UNKNOWN_ERROR</b> = 1,
- <br />
-   <b>AFC_E_OP_HEADER_INVALID</b> = 2,
- <br />
-   <b>AFC_E_NO_RESOURCES</b> = 3,
- <br />
-   <b>AFC_E_READ_ERROR</b> = 4,
- <br />
-   <b>AFC_E_WRITE_ERROR</b> = 5,
- <br />
-   <b>AFC_E_UNKNOWN_PACKET_TYPE</b> = 6,
- <br />
-   <b>AFC_E_INVALID_ARG</b> = 7,
- <br />
-   <b>AFC_E_OBJECT_NOT_FOUND</b> = 8,
- <br />
-   <b>AFC_E_OBJECT_IS_DIR</b> = 9,
- <br />
-   <b>AFC_E_PERM_DENIED</b> = 10,
- <br />
-   <b>AFC_E_SERVICE_NOT_CONNECTED</b> = 11,
- <br />
-   <b>AFC_E_OP_TIMEOUT</b> = 12,
- <br />
-   <b>AFC_E_TOO_MUCH_DATA</b> = 13,
- <br />
-   <b>AFC_E_END_OF_DATA</b> = 14,
- <br />
-   <b>AFC_E_OP_NOT_SUPPORTED</b> = 15,
- <br />
-   <b>AFC_E_OBJECT_EXISTS</b> = 16,
- <br />
-   <b>AFC_E_OBJECT_BUSY</b> = 17,
- <br />
-   <b>AFC_E_NO_SPACE_LEFT</b> = 18,
- <br />
-   <b>AFC_E_OP_WOULD_BLOCK</b> = 19,
- <br />
-   <b>AFC_E_IO_ERROR</b> = 20,
- <br />
-   <b>AFC_E_OP_INTERRUPTED</b> = 21,
- <br />
-   <b>AFC_E_OP_IN_PROGRESS</b> = 22,
- <br />
-   <b>AFC_E_INTERNAL_ERROR</b> = 23,
- <br />
-   <b>AFC_E_MUX_ERROR</b> = 30,
- <br />
-   <b>AFC_E_NO_MEM</b> = 31,
- <br />
-   <b>AFC_E_NOT_ENOUGH_DATA</b> = 32,
- <br />
-   <b>AFC_E_DIR_NOT_EMPTY</b> = 33,
- <br />
-   <b>AFC_E_FORCE_SIGNED_TYPE</b> = -1
- <br />
- }</td></tr>
- <tr class="memdesc:a913481f73acbd6026a4663bd7ec3f6c9"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a913481f73acbd6026a4663bd7ec3f6c9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7a2fa8f957bce530bd7b3aa8c3c3bf3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3">afc_file_mode_t</a> { <br />
-   <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3ace320ad23183a226f6190ced9b964a3d">AFC_FOPEN_RDONLY</a> = 0x00000001,
- <br />
-   <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3adf63c6ca559c2a71e3a38b03f92b83bf">AFC_FOPEN_RW</a> = 0x00000002,
- <br />
-   <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3a5602b891683cb6ecbce94de52282c59f">AFC_FOPEN_WRONLY</a> = 0x00000003,
- <br />
-   <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3ae06639e4e35efa0bc1087604fde1e86b">AFC_FOPEN_WR</a> = 0x00000004,
- <br />
-   <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3a94b02ac741240ef5ca1e8355cdf164e5">AFC_FOPEN_APPEND</a> = 0x00000005,
- <br />
-   <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3a5e28cdfc3c3a503669a4a9aaef53b183">AFC_FOPEN_RDAPPEND</a> = 0x00000006
- <br />
- }</td></tr>
- <tr class="memdesc:af7a2fa8f957bce530bd7b3aa8c3c3bf3"><td class="mdescLeft"> </td><td class="mdescRight">Flags for afc_file_open. <a href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3">More...</a><br /></td></tr>
- <tr class="separator:af7a2fa8f957bce530bd7b3aa8c3c3bf3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1885d5e53edde8732633621768db5908"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1885d5e53edde8732633621768db5908"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a1885d5e53edde8732633621768db5908">afc_link_type_t</a> { <br />
-   <b>AFC_HARDLINK</b> = 1,
- <br />
-   <b>AFC_SYMLINK</b> = 2
- <br />
- }</td></tr>
- <tr class="memdesc:a1885d5e53edde8732633621768db5908"><td class="mdescLeft"> </td><td class="mdescRight">Type of link for <a class="el" href="afc_8h.html#ab5ade933b44d1f913df91d1065faa33a" title="Creates a hard link or symbolic link on the device. ">afc_make_link()</a> calls. <br /></td></tr>
- <tr class="separator:a1885d5e53edde8732633621768db5908"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab249684dc55f8ec52b31db88fff35d9f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9f">afc_lock_op_t</a> { <br />
-   <a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9fad8a9e6665fb10f161b6b8f39c612c9e4">AFC_LOCK_SH</a> = 1 | 4,
- <br />
-   <a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9fac7449d6d73af14e0250d645c6d8730ff">AFC_LOCK_EX</a> = 2 | 4,
- <br />
-   <a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9facde3c1991b04c6277021250d44e3eb65">AFC_LOCK_UN</a> = 8 | 4
- <br />
- }</td></tr>
- <tr class="memdesc:ab249684dc55f8ec52b31db88fff35d9f"><td class="mdescLeft"> </td><td class="mdescRight">Lock operation flags. <a href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9f">More...</a><br /></td></tr>
- <tr class="separator:ab249684dc55f8ec52b31db88fff35d9f"><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:a1d583fa6613e8ecf0cae4d3481d2ff1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a1d583fa6613e8ecf0cae4d3481d2ff1e">afc_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> *client)</td></tr>
- <tr class="memdesc:a1d583fa6613e8ecf0cae4d3481d2ff1e"><td class="mdescLeft"> </td><td class="mdescRight">Makes a connection to the AFC service on the device. <a href="#a1d583fa6613e8ecf0cae4d3481d2ff1e">More...</a><br /></td></tr>
- <tr class="separator:a1d583fa6613e8ecf0cae4d3481d2ff1e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab7d7f5ef576d66aab3ab6ebf13d55739"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#ab7d7f5ef576d66aab3ab6ebf13d55739">afc_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> *client, const char *label)</td></tr>
- <tr class="memdesc:ab7d7f5ef576d66aab3ab6ebf13d55739"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new AFC service on the specified device and connects to it. <a href="#ab7d7f5ef576d66aab3ab6ebf13d55739">More...</a><br /></td></tr>
- <tr class="separator:ab7d7f5ef576d66aab3ab6ebf13d55739"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1cee6b357bdd7f187b7411a41c136412"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a1cee6b357bdd7f187b7411a41c136412">afc_client_free</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client)</td></tr>
- <tr class="memdesc:a1cee6b357bdd7f187b7411a41c136412"><td class="mdescLeft"> </td><td class="mdescRight">Frees up an AFC client. <a href="#a1cee6b357bdd7f187b7411a41c136412">More...</a><br /></td></tr>
- <tr class="separator:a1cee6b357bdd7f187b7411a41c136412"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab08695945568115d4d214b989296362a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#ab08695945568115d4d214b989296362a">afc_get_device_info</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, char ***device_information)</td></tr>
- <tr class="memdesc:ab08695945568115d4d214b989296362a"><td class="mdescLeft"> </td><td class="mdescRight">Get device information for a connected client. <a href="#ab08695945568115d4d214b989296362a">More...</a><br /></td></tr>
- <tr class="separator:ab08695945568115d4d214b989296362a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b2afd368d027a0ea8b40b397d76542a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a0b2afd368d027a0ea8b40b397d76542a">afc_read_directory</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *path, char ***directory_information)</td></tr>
- <tr class="memdesc:a0b2afd368d027a0ea8b40b397d76542a"><td class="mdescLeft"> </td><td class="mdescRight">Gets a directory listing of the directory requested. <a href="#a0b2afd368d027a0ea8b40b397d76542a">More...</a><br /></td></tr>
- <tr class="separator:a0b2afd368d027a0ea8b40b397d76542a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab68adfcb71713bbf76c7527b6ddf2c68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#ab68adfcb71713bbf76c7527b6ddf2c68">afc_get_file_info</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *filename, char ***file_information)</td></tr>
- <tr class="memdesc:ab68adfcb71713bbf76c7527b6ddf2c68"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about a specific file. <a href="#ab68adfcb71713bbf76c7527b6ddf2c68">More...</a><br /></td></tr>
- <tr class="separator:ab68adfcb71713bbf76c7527b6ddf2c68"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2dbfca1d64e26daf9691ba2ddabc92ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a2dbfca1d64e26daf9691ba2ddabc92ba">afc_file_open</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *filename, <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3">afc_file_mode_t</a> file_mode, uint64_t *handle)</td></tr>
- <tr class="memdesc:a2dbfca1d64e26daf9691ba2ddabc92ba"><td class="mdescLeft"> </td><td class="mdescRight">Opens a file on the device. <a href="#a2dbfca1d64e26daf9691ba2ddabc92ba">More...</a><br /></td></tr>
- <tr class="separator:a2dbfca1d64e26daf9691ba2ddabc92ba"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adb90e6f46af885948a91d328ca2e8c21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#adb90e6f46af885948a91d328ca2e8c21">afc_file_close</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle)</td></tr>
- <tr class="memdesc:adb90e6f46af885948a91d328ca2e8c21"><td class="mdescLeft"> </td><td class="mdescRight">Closes a file on the device. <a href="#adb90e6f46af885948a91d328ca2e8c21">More...</a><br /></td></tr>
- <tr class="separator:adb90e6f46af885948a91d328ca2e8c21"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a37c91f506bdab578d2eec9145fd7d9a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a37c91f506bdab578d2eec9145fd7d9a7">afc_file_lock</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle, <a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9f">afc_lock_op_t</a> operation)</td></tr>
- <tr class="memdesc:a37c91f506bdab578d2eec9145fd7d9a7"><td class="mdescLeft"> </td><td class="mdescRight">Locks or unlocks a file on the device. <a href="#a37c91f506bdab578d2eec9145fd7d9a7">More...</a><br /></td></tr>
- <tr class="separator:a37c91f506bdab578d2eec9145fd7d9a7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6a30ec41e4e9b7a7f1011c52917e3a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#aa6a30ec41e4e9b7a7f1011c52917e3a3">afc_file_read</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle, char *data, uint32_t length, uint32_t *bytes_read)</td></tr>
- <tr class="memdesc:aa6a30ec41e4e9b7a7f1011c52917e3a3"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to the read the given number of bytes from the given file. <a href="#aa6a30ec41e4e9b7a7f1011c52917e3a3">More...</a><br /></td></tr>
- <tr class="separator:aa6a30ec41e4e9b7a7f1011c52917e3a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a034289b2f220b0f56f2155537e59d2ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a034289b2f220b0f56f2155537e59d2ab">afc_file_write</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle, const char *data, uint32_t length, uint32_t *bytes_written)</td></tr>
- <tr class="memdesc:a034289b2f220b0f56f2155537e59d2ab"><td class="mdescLeft"> </td><td class="mdescRight">Writes a given number of bytes to a file. <a href="#a034289b2f220b0f56f2155537e59d2ab">More...</a><br /></td></tr>
- <tr class="separator:a034289b2f220b0f56f2155537e59d2ab"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f0ebaea303e1fe2b84082ca40e3468d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a3f0ebaea303e1fe2b84082ca40e3468d">afc_file_seek</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle, int64_t offset, int whence)</td></tr>
- <tr class="memdesc:a3f0ebaea303e1fe2b84082ca40e3468d"><td class="mdescLeft"> </td><td class="mdescRight">Seeks to a given position of a pre-opened file on the device. <a href="#a3f0ebaea303e1fe2b84082ca40e3468d">More...</a><br /></td></tr>
- <tr class="separator:a3f0ebaea303e1fe2b84082ca40e3468d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ba8a781ea81b2ce09d2fd8a182b3624"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a5ba8a781ea81b2ce09d2fd8a182b3624">afc_file_tell</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle, uint64_t *position)</td></tr>
- <tr class="memdesc:a5ba8a781ea81b2ce09d2fd8a182b3624"><td class="mdescLeft"> </td><td class="mdescRight">Returns current position in a pre-opened file on the device. <a href="#a5ba8a781ea81b2ce09d2fd8a182b3624">More...</a><br /></td></tr>
- <tr class="separator:a5ba8a781ea81b2ce09d2fd8a182b3624"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad1e44fb7e9b6445841813f522705a721"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#ad1e44fb7e9b6445841813f522705a721">afc_file_truncate</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, uint64_t handle, uint64_t newsize)</td></tr>
- <tr class="memdesc:ad1e44fb7e9b6445841813f522705a721"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of a file on the device. <a href="#ad1e44fb7e9b6445841813f522705a721">More...</a><br /></td></tr>
- <tr class="separator:ad1e44fb7e9b6445841813f522705a721"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aefd69b3b2168543c06833f9507858b63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#aefd69b3b2168543c06833f9507858b63">afc_remove_path</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *path)</td></tr>
- <tr class="memdesc:aefd69b3b2168543c06833f9507858b63"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a file or directory. <a href="#aefd69b3b2168543c06833f9507858b63">More...</a><br /></td></tr>
- <tr class="separator:aefd69b3b2168543c06833f9507858b63"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0c783fb34679a9be39e96aeac2f38801"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a0c783fb34679a9be39e96aeac2f38801">afc_rename_path</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *from, const char *to)</td></tr>
- <tr class="memdesc:a0c783fb34679a9be39e96aeac2f38801"><td class="mdescLeft"> </td><td class="mdescRight">Renames a file or directory on the device. <a href="#a0c783fb34679a9be39e96aeac2f38801">More...</a><br /></td></tr>
- <tr class="separator:a0c783fb34679a9be39e96aeac2f38801"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aabbd741d82ee87d3569a0c2346a47172"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#aabbd741d82ee87d3569a0c2346a47172">afc_make_directory</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *path)</td></tr>
- <tr class="memdesc:aabbd741d82ee87d3569a0c2346a47172"><td class="mdescLeft"> </td><td class="mdescRight">Creates a directory on the device. <a href="#aabbd741d82ee87d3569a0c2346a47172">More...</a><br /></td></tr>
- <tr class="separator:aabbd741d82ee87d3569a0c2346a47172"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8b2a2e73c45e378379fe3e7daddd717b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a8b2a2e73c45e378379fe3e7daddd717b">afc_truncate</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *path, uint64_t newsize)</td></tr>
- <tr class="memdesc:a8b2a2e73c45e378379fe3e7daddd717b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of a file on the device without prior opening it. <a href="#a8b2a2e73c45e378379fe3e7daddd717b">More...</a><br /></td></tr>
- <tr class="separator:a8b2a2e73c45e378379fe3e7daddd717b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab5ade933b44d1f913df91d1065faa33a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#ab5ade933b44d1f913df91d1065faa33a">afc_make_link</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, <a class="el" href="afc_8h.html#a1885d5e53edde8732633621768db5908">afc_link_type_t</a> linktype, const char *target, const char *linkname)</td></tr>
- <tr class="memdesc:ab5ade933b44d1f913df91d1065faa33a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a hard link or symbolic link on the device. <a href="#ab5ade933b44d1f913df91d1065faa33a">More...</a><br /></td></tr>
- <tr class="separator:ab5ade933b44d1f913df91d1065faa33a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7783580ec92f8374e1e0836ac006cf07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a7783580ec92f8374e1e0836ac006cf07">afc_set_file_time</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *path, uint64_t mtime)</td></tr>
- <tr class="memdesc:a7783580ec92f8374e1e0836ac006cf07"><td class="mdescLeft"> </td><td class="mdescRight">Sets the modification time of a file on the device. <a href="#a7783580ec92f8374e1e0836ac006cf07">More...</a><br /></td></tr>
- <tr class="separator:a7783580ec92f8374e1e0836ac006cf07"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0ff08c085470f79c904d530f9c7e13f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a0ff08c085470f79c904d530f9c7e13f8">afc_remove_path_and_contents</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *path)</td></tr>
- <tr class="memdesc:a0ff08c085470f79c904d530f9c7e13f8"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a file or directory including possible contents. <a href="#a0ff08c085470f79c904d530f9c7e13f8">More...</a><br /></td></tr>
- <tr class="separator:a0ff08c085470f79c904d530f9c7e13f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6b5608bfa08dc160ef68e49c4da167d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a6b5608bfa08dc160ef68e49c4da167d9">afc_get_device_info_key</a> (<a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> client, const char *key, char **value)</td></tr>
- <tr class="memdesc:a6b5608bfa08dc160ef68e49c4da167d9"><td class="mdescLeft"> </td><td class="mdescRight">Get a specific key of the device info list for a client connection. <a href="#a6b5608bfa08dc160ef68e49c4da167d9">More...</a><br /></td></tr>
- <tr class="separator:a6b5608bfa08dc160ef68e49c4da167d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0d9bc71e361a36156c8e1e3482dc124a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="afc_8h.html#a0d9bc71e361a36156c8e1e3482dc124a">afc_dictionary_free</a> (char **dictionary)</td></tr>
- <tr class="memdesc:a0d9bc71e361a36156c8e1e3482dc124a"><td class="mdescLeft"> </td><td class="mdescRight">Frees up a char dictionary as returned by some AFC functions. <a href="#a0d9bc71e361a36156c8e1e3482dc124a">More...</a><br /></td></tr>
- <tr class="separator:a0d9bc71e361a36156c8e1e3482dc124a"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Access the filesystem on the device. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a06351ca31179c322c0a5eb4f13296ec7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef afc_client_private* <a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The client handle. </p>
- </div>
- </div>
- <h2 class="groupheader">Enumeration Type Documentation</h2>
- <a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3">afc_file_mode_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Flags for afc_file_open. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3ace320ad23183a226f6190ced9b964a3d"></a>AFC_FOPEN_RDONLY </td><td class="fielddoc">
- <p>r O_RDONLY </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3adf63c6ca559c2a71e3a38b03f92b83bf"></a>AFC_FOPEN_RW </td><td class="fielddoc">
- <p>r+ O_RDWR | O_CREAT </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3a5602b891683cb6ecbce94de52282c59f"></a>AFC_FOPEN_WRONLY </td><td class="fielddoc">
- <p>w O_WRONLY | O_CREAT | O_TRUNC </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3ae06639e4e35efa0bc1087604fde1e86b"></a>AFC_FOPEN_WR </td><td class="fielddoc">
- <p>w+ O_RDWR | O_CREAT | O_TRUNC </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3a94b02ac741240ef5ca1e8355cdf164e5"></a>AFC_FOPEN_APPEND </td><td class="fielddoc">
- <p>a O_WRONLY | O_APPEND | O_CREAT </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="af7a2fa8f957bce530bd7b3aa8c3c3bf3a5e28cdfc3c3a503669a4a9aaef53b183"></a>AFC_FOPEN_RDAPPEND </td><td class="fielddoc">
- <p>a+ O_RDWR | O_APPEND | O_CREAT </p>
- </td></tr>
- </table>
- </div>
- </div>
- <a class="anchor" id="ab249684dc55f8ec52b31db88fff35d9f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9f">afc_lock_op_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Lock operation flags. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ab249684dc55f8ec52b31db88fff35d9fad8a9e6665fb10f161b6b8f39c612c9e4"></a>AFC_LOCK_SH </td><td class="fielddoc">
- <p>shared lock </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ab249684dc55f8ec52b31db88fff35d9fac7449d6d73af14e0250d645c6d8730ff"></a>AFC_LOCK_EX </td><td class="fielddoc">
- <p>exclusive lock </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ab249684dc55f8ec52b31db88fff35d9facde3c1991b04c6277021250d44e3eb65"></a>AFC_LOCK_UN </td><td class="fielddoc">
- <p>unlock </p>
- </td></tr>
- </table>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="a1cee6b357bdd7f187b7411a41c136412"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Frees up an AFC client. </p>
- <p>If the connection was created by the client itself, the connection will be closed.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to free. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a1d583fa6613e8ecf0cae4d3481d2ff1e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_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="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>Makes a connection to the AFC service on the 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 be set to a newly allocated afc_client_t upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success, AFC_E_INVALID_ARG if device or service is invalid, AFC_E_MUX_ERROR if the connection cannot be established, or AFC_E_NO_MEM if there is a memory allocation problem. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab7d7f5ef576d66aab3ab6ebf13d55739"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_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="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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 AFC 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 afc_client_t upon successful return. Must be freed using <a class="el" href="afc_8h.html#a1cee6b357bdd7f187b7411a41c136412" title="Frees up an AFC client. ">afc_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>AFC_E_SUCCESS on success, or an AFC_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0d9bc71e361a36156c8e1e3482dc124a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_dictionary_free </td>
- <td>(</td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>dictionary</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Frees up a char dictionary as returned by some AFC functions. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">dictionary</td><td>The char array terminated by an empty string.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="adb90e6f46af885948a91d328ca2e8c21"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_close </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Closes a file on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to close the file with. </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of a previously opened file. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a37c91f506bdab578d2eec9145fd7d9a7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_lock </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="afc_8h.html#ab249684dc55f8ec52b31db88fff35d9f">afc_lock_op_t</a> </td>
- <td class="paramname"><em>operation</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Locks or unlocks a file on the device. </p>
- <p>Makes use of flock on the device. </p><dl class="section see"><dt>See also</dt><dd><a href="http://developer.apple.com/documentation/Darwin/Reference/ManPages/man2/flock.2.html">http://developer.apple.com/documentation/Darwin/Reference/ManPages/man2/flock.2.html</a></dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to lock the file with. </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of a previously opened file. </td></tr>
- <tr><td class="paramname">operation</td><td>the lock or unlock operation to perform, this is one of AFC_LOCK_SH (shared lock), AFC_LOCK_EX (exclusive lock), or AFC_LOCK_UN (unlock). </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a2dbfca1d64e26daf9691ba2ddabc92ba"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_open </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>filename</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="afc_8h.html#af7a2fa8f957bce530bd7b3aa8c3c3bf3">afc_file_mode_t</a> </td>
- <td class="paramname"><em>file_mode</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t * </td>
- <td class="paramname"><em>handle</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Opens a file on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to open the file. </td></tr>
- <tr><td class="paramname">filename</td><td>The file to open. (must be a fully-qualified path) </td></tr>
- <tr><td class="paramname">file_mode</td><td>The mode to use to open the file. </td></tr>
- <tr><td class="paramname">handle</td><td>Pointer to a uint64_t that will hold the handle of the file</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aa6a30ec41e4e9b7a7f1011c52917e3a3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_read </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>length</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t * </td>
- <td class="paramname"><em>bytes_read</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Attempts to the read the given number of bytes from the given file. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The relevant AFC client </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of a previously opened file </td></tr>
- <tr><td class="paramname">data</td><td>The pointer to the memory region to store the read data </td></tr>
- <tr><td class="paramname">length</td><td>The number of bytes to read </td></tr>
- <tr><td class="paramname">bytes_read</td><td>The number of bytes actually read.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a3f0ebaea303e1fe2b84082ca40e3468d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_seek </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int64_t </td>
- <td class="paramname"><em>offset</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>whence</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Seeks to a given position of a pre-opened file on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to seek to the position. </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of a previously opened. </td></tr>
- <tr><td class="paramname">offset</td><td>Seek offset. </td></tr>
- <tr><td class="paramname">whence</td><td>Seeking direction, one of SEEK_SET, SEEK_CUR, or SEEK_END.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5ba8a781ea81b2ce09d2fd8a182b3624"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_tell </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t * </td>
- <td class="paramname"><em>position</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns current position in a pre-opened file on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use. </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of a previously opened file. </td></tr>
- <tr><td class="paramname">position</td><td>Position in bytes of indicator</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad1e44fb7e9b6445841813f522705a721"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_truncate </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>newsize</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the size of a file on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to set the file size. </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of a previously opened file. </td></tr>
- <tr><td class="paramname">newsize</td><td>The size to set the file to.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value.</dd></dl>
- <dl class="section note"><dt>Note</dt><dd>This function is more akin to ftruncate than truncate, and truncate calls would have to open the file before calling this, sadly. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a034289b2f220b0f56f2155537e59d2ab"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_file_write </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>handle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>length</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t * </td>
- <td class="paramname"><em>bytes_written</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Writes a given number of bytes to a file. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to write to the file. </td></tr>
- <tr><td class="paramname">handle</td><td>File handle of previously opened file. </td></tr>
- <tr><td class="paramname">data</td><td>The data to write to the file. </td></tr>
- <tr><td class="paramname">length</td><td>How much data to write. </td></tr>
- <tr><td class="paramname">bytes_written</td><td>The number of bytes actually written to the file.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab08695945568115d4d214b989296362a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_get_device_info </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>device_information</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get device information for a connected client. </p>
- <p>The device information returned is the device model as well as the free space, the total capacity and blocksize on the accessed disk partition.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to get device info for. </td></tr>
- <tr><td class="paramname">device_information</td><td>A char list of device information terminated by an empty string or NULL if there was an error. Free with <a class="el" href="afc_8h.html#a0d9bc71e361a36156c8e1e3482dc124a" title="Frees up a char dictionary as returned by some AFC functions. ">afc_dictionary_free()</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a6b5608bfa08dc160ef68e49c4da167d9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_get_device_info_key </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a specific key of the device info list for a client connection. </p>
- <p>Known key values are: Model, FSTotalBytes, FSFreeBytes and FSBlockSize. This is a helper function for <a class="el" href="afc_8h.html#ab08695945568115d4d214b989296362a" title="Get device information for a connected client. ">afc_get_device_info()</a>.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to get device info for. </td></tr>
- <tr><td class="paramname">key</td><td>The key to get the value of. </td></tr>
- <tr><td class="paramname">value</td><td>The value for the key if successful or NULL otherwise.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab68adfcb71713bbf76c7527b6ddf2c68"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_get_file_info </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>filename</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char *** </td>
- <td class="paramname"><em>file_information</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets information about a specific file. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to get the information of the file. </td></tr>
- <tr><td class="paramname">path</td><td>The fully-qualified path to the file. </td></tr>
- <tr><td class="paramname">file_information</td><td>Pointer to a buffer that will be filled with a NULL-terminated list of strings with the file information. Set to NULL before calling this function. Free with <a class="el" href="afc_8h.html#a0d9bc71e361a36156c8e1e3482dc124a" title="Frees up a char dictionary as returned by some AFC functions. ">afc_dictionary_free()</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aabbd741d82ee87d3569a0c2346a47172"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_make_directory </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>path</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Creates a directory on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to make a directory. </td></tr>
- <tr><td class="paramname">path</td><td>The directory's path. (must be a fully-qualified path, I assume all other mkdir restrictions apply as well)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab5ade933b44d1f913df91d1065faa33a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_make_link </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a1885d5e53edde8732633621768db5908">afc_link_type_t</a> </td>
- <td class="paramname"><em>linktype</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>target</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>linkname</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Creates a hard link or symbolic link on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use for making a link </td></tr>
- <tr><td class="paramname">linktype</td><td>1 = hard link, 2 = symlink </td></tr>
- <tr><td class="paramname">target</td><td>The file to be linked. </td></tr>
- <tr><td class="paramname">linkname</td><td>The name of link.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0b2afd368d027a0ea8b40b397d76542a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_read_directory </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char *** </td>
- <td class="paramname"><em>directory_information</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets a directory listing of the directory requested. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to get a directory listing from. </td></tr>
- <tr><td class="paramname">path</td><td>The directory for listing. (must be a fully-qualified path) </td></tr>
- <tr><td class="paramname">directory_information</td><td>A char list of files in the directory terminated by an empty string or NULL if there was an error. Free with <a class="el" href="afc_8h.html#a0d9bc71e361a36156c8e1e3482dc124a" title="Frees up a char dictionary as returned by some AFC functions. ">afc_dictionary_free()</a>.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aefd69b3b2168543c06833f9507858b63"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_remove_path </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>path</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Deletes a file or directory. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use. </td></tr>
- <tr><td class="paramname">path</td><td>The path to delete. (must be a fully-qualified path)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0ff08c085470f79c904d530f9c7e13f8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_remove_path_and_contents </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>path</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Deletes a file or directory including possible contents. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use. </td></tr>
- <tr><td class="paramname">path</td><td>The path to delete. (must be a fully-qualified path) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section since"><dt>Since</dt><dd>libimobiledevice 1.1.7 </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Only available in iOS 6 and later.</dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0c783fb34679a9be39e96aeac2f38801"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_rename_path </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>from</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>to</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Renames a file or directory on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to have rename. </td></tr>
- <tr><td class="paramname">from</td><td>The name to rename from. (must be a fully-qualified path) </td></tr>
- <tr><td class="paramname">to</td><td>The new name. (must also be a fully-qualified path)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7783580ec92f8374e1e0836ac006cf07"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_set_file_time </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>mtime</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the modification time of a file on the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to set the file size. </td></tr>
- <tr><td class="paramname">path</td><td>Path of the file for which the modification time should be set. </td></tr>
- <tr><td class="paramname">mtime</td><td>The modification time to set in nanoseconds since epoch.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a8b2a2e73c45e378379fe3e7daddd717b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="afc_8h.html#a913481f73acbd6026a4663bd7ec3f6c9">afc_error_t</a> afc_truncate </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="afc_8h.html#a06351ca31179c322c0a5eb4f13296ec7">afc_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>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>newsize</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the size of a file on the device without prior opening it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The client to use to set the file size. </td></tr>
- <tr><td class="paramname">path</td><td>The path of the file to be truncated. </td></tr>
- <tr><td class="paramname">newsize</td><td>The size to set the file to.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>AFC_E_SUCCESS on success or an AFC_E_* error value. </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>
|