Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
Diff: doc/html/group__api__file.html
- Revision:
- 13:2b51f5267c92
- Parent:
- 11:ea484e1b7fc4
- Child:
- 26:8067e3d463d3
--- a/doc/html/group__api__file.html Tue Aug 12 02:44:34 2014 -0700 +++ b/doc/html/group__api__file.html Wed Aug 13 03:14:30 2014 -0700 @@ -3,8 +3,9 @@ <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.7"/> -<title>WiConnect Library: File API</title> +<title>ACKme WiConnect Host Library</title> +<link rel="icon" href="favicon.ico" type="image/x-icon"> +<link rel="shortcut icon" href="favicon.ico" type="image/x-icon"> <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> @@ -24,29 +25,30 @@ </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">WiConnect Library - </div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.7 --> +<div id="titlearea" style="font-family:verdana;"> + <table border='0' cellpadding='0' cellspacing='0' width="98%"> + <tr style="height:20px"><td> </td></tr> + <tr style="border-collapse: collapse; padding: 0;"> + <td style="width:20px"></td> + <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td> + <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;"> + WiConnect Host Library- API Reference Guide</td> + <td style="width:20px"></td> + </tr> + <tr><td> </td></tr> + </table> +</div><!-- Generated by Doxygen 1.8.7 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="modules.html"><span>Modules</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="index.html"><span>Library Overview</span></a></li> + <li><a href="modules.html"><span>Library API</span></a></li> + <li><a href="examples.html"><span>API Examples</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li> + <li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> @@ -96,56 +98,38 @@ <div class="header"> <div class="summary"> -<a href="#groups">Modules</a> | -<a href="#func-members">Functions</a> </div> +<a href="#groups">Modules</a> </div> <div class="headertitle"> -<div class="title">File API</div> </div> +<div class="title">File</div> </div> </div><!--header--> <div class="contents"> -<p>This contains all file API Library methods. +<p>This contains all file methods. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> Modules</h2></td></tr> +<tr class="memitem:group__api__file__methods"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html">Methods</a></td></tr> +<tr class="memdesc:group__api__file__methods"><td class="mdescLeft"> </td><td class="mdescRight">File Types. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group__api__file__types"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__types.html">Types</a></td></tr> +<tr class="memdesc:group__api__file__types"><td class="mdescLeft"> </td><td class="mdescRight">File Types. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:group__api__file__macro"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__macro.html">Macros</a></td></tr> <tr class="memdesc:group__api__file__macro"><td class="mdescLeft"> </td><td class="mdescRight">API specific macros. <br /></td></tr> <tr class="separator:"><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:ga16fb09105975644879eb09581ce486e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga16fb09105975644879eb09581ce486e5"></a> -<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga16fb09105975644879eb09581ce486e5">wiconnect::FileInterface::createFile</a> (const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *name, uint32_t size, uint32_t version=0, <a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</td></tr> -<tr class="memdesc:ga16fb09105975644879eb09581ce486e5"><td class="mdescLeft"> </td><td class="mdescRight">Create a file on the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module flash filesystem. <br /></td></tr> -<tr class="separator:ga16fb09105975644879eb09581ce486e5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4b14d6c68d4d0239e150def385c334a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b14d6c68d4d0239e150def385c334a4"></a> -<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga4b14d6c68d4d0239e150def385c334a4">wiconnect::FileInterface::openFile</a> (<a class="el" href="classwiconnect_1_1_file.html">File</a> &file, const char *name)</td></tr> -<tr class="memdesc:ga4b14d6c68d4d0239e150def385c334a4"><td class="mdescLeft"> </td><td class="mdescRight">Open a file on the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module flash filesystem for reading. <br /></td></tr> -<tr class="separator:ga4b14d6c68d4d0239e150def385c334a4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafcf335cef42b7b3d0fd9d5af70c6ef7d"></a> -<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">wiconnect::FileInterface::deleteFile</a> (const char *name)</td></tr> -<tr class="memdesc:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="mdescLeft"> </td><td class="mdescRight">Delete a file for the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module flash filesystem. <br /></td></tr> -<tr class="separator:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga498cb32c0877b69c2c97365e5c309c46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga498cb32c0877b69c2c97365e5c309c46"></a> -<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga498cb32c0877b69c2c97365e5c309c46">wiconnect::FileInterface::deleteFile</a> (const <a class="el" href="classwiconnect_1_1_file.html">File</a> &file)</td></tr> -<tr class="memdesc:ga498cb32c0877b69c2c97365e5c309c46"><td class="mdescLeft"> </td><td class="mdescRight">Delete a file for the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module flash filesystem. <br /></td></tr> -<tr class="separator:ga498cb32c0877b69c2c97365e5c309c46"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga10536639c61213c037883dade021838f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga10536639c61213c037883dade021838f"></a> -<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga10536639c61213c037883dade021838f">wiconnect::FileInterface::listFiles</a> (<a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> &list, const char *name=NULL, <a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, uint32_t version=0)</td></tr> -<tr class="memdesc:ga10536639c61213c037883dade021838f"><td class="mdescLeft"> </td><td class="mdescRight">List the files on the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module flash filesystem. <br /></td></tr> -<tr class="separator:ga10536639c61213c037883dade021838f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group__api__file__examples"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__examples.html">Examples</a></td></tr> +<tr class="memdesc:group__api__file__examples"><td class="mdescLeft"> </td><td class="mdescRight">File examples. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>This contains all file API Library methods. </p> +<p>This contains all file methods. </p> </div><!-- contents --> </div><!-- doc-content --> -<!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li> + <li class="footer">© ACKme Networks 2014</li> </ul> </div> </body> -</html> +</html> \ No newline at end of file