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
doc/html/group__api__file.html@11:ea484e1b7fc4, 2014-08-12 (annotated)
- Committer:
- dan_ackme
- Date:
- Tue Aug 12 02:34:46 2014 -0700
- Revision:
- 11:ea484e1b7fc4
- Child:
- 13:2b51f5267c92
updated documnetation
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dan_ackme | 11:ea484e1b7fc4 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
dan_ackme | 11:ea484e1b7fc4 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
dan_ackme | 11:ea484e1b7fc4 | 3 | <head> |
dan_ackme | 11:ea484e1b7fc4 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
dan_ackme | 11:ea484e1b7fc4 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
dan_ackme | 11:ea484e1b7fc4 | 6 | <meta name="generator" content="Doxygen 1.8.7"/> |
dan_ackme | 11:ea484e1b7fc4 | 7 | <title>WiConnect Library: File API</title> |
dan_ackme | 11:ea484e1b7fc4 | 8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 9 | <script type="text/javascript" src="jquery.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 10 | <script type="text/javascript" src="dynsections.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 11 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 12 | <script type="text/javascript" src="resize.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 13 | <script type="text/javascript" src="navtree.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 14 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 15 | $(document).ready(initResizable); |
dan_ackme | 11:ea484e1b7fc4 | 16 | $(window).load(resizeHeight); |
dan_ackme | 11:ea484e1b7fc4 | 17 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 18 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 19 | <script type="text/javascript" src="search/search.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 20 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 21 | $(document).ready(function() { searchBox.OnSelectItem(0); }); |
dan_ackme | 11:ea484e1b7fc4 | 22 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 23 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
dan_ackme | 11:ea484e1b7fc4 | 24 | </head> |
dan_ackme | 11:ea484e1b7fc4 | 25 | <body> |
dan_ackme | 11:ea484e1b7fc4 | 26 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
dan_ackme | 11:ea484e1b7fc4 | 27 | <div id="titlearea"> |
dan_ackme | 11:ea484e1b7fc4 | 28 | <table cellspacing="0" cellpadding="0"> |
dan_ackme | 11:ea484e1b7fc4 | 29 | <tbody> |
dan_ackme | 11:ea484e1b7fc4 | 30 | <tr style="height: 56px;"> |
dan_ackme | 11:ea484e1b7fc4 | 31 | <td style="padding-left: 0.5em;"> |
dan_ackme | 11:ea484e1b7fc4 | 32 | <div id="projectname">WiConnect Library |
dan_ackme | 11:ea484e1b7fc4 | 33 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 34 | </td> |
dan_ackme | 11:ea484e1b7fc4 | 35 | </tr> |
dan_ackme | 11:ea484e1b7fc4 | 36 | </tbody> |
dan_ackme | 11:ea484e1b7fc4 | 37 | </table> |
dan_ackme | 11:ea484e1b7fc4 | 38 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 39 | <!-- end header part --> |
dan_ackme | 11:ea484e1b7fc4 | 40 | <!-- Generated by Doxygen 1.8.7 --> |
dan_ackme | 11:ea484e1b7fc4 | 41 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 42 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
dan_ackme | 11:ea484e1b7fc4 | 43 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 44 | <div id="navrow1" class="tabs"> |
dan_ackme | 11:ea484e1b7fc4 | 45 | <ul class="tablist"> |
dan_ackme | 11:ea484e1b7fc4 | 46 | <li><a href="index.html"><span>Main Page</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 47 | <li><a href="modules.html"><span>Modules</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 48 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 49 | <li><a href="annotated.html"><span>Classes</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 50 | <li> |
dan_ackme | 11:ea484e1b7fc4 | 51 | <div id="MSearchBox" class="MSearchBoxInactive"> |
dan_ackme | 11:ea484e1b7fc4 | 52 | <span class="left"> |
dan_ackme | 11:ea484e1b7fc4 | 53 | <img id="MSearchSelect" src="search/mag_sel.png" |
dan_ackme | 11:ea484e1b7fc4 | 54 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 11:ea484e1b7fc4 | 55 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 11:ea484e1b7fc4 | 56 | alt=""/> |
dan_ackme | 11:ea484e1b7fc4 | 57 | <input type="text" id="MSearchField" value="Search" accesskey="S" |
dan_ackme | 11:ea484e1b7fc4 | 58 | onfocus="searchBox.OnSearchFieldFocus(true)" |
dan_ackme | 11:ea484e1b7fc4 | 59 | onblur="searchBox.OnSearchFieldFocus(false)" |
dan_ackme | 11:ea484e1b7fc4 | 60 | onkeyup="searchBox.OnSearchFieldChange(event)"/> |
dan_ackme | 11:ea484e1b7fc4 | 61 | </span><span class="right"> |
dan_ackme | 11:ea484e1b7fc4 | 62 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
dan_ackme | 11:ea484e1b7fc4 | 63 | </span> |
dan_ackme | 11:ea484e1b7fc4 | 64 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 65 | </li> |
dan_ackme | 11:ea484e1b7fc4 | 66 | </ul> |
dan_ackme | 11:ea484e1b7fc4 | 67 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 68 | </div><!-- top --> |
dan_ackme | 11:ea484e1b7fc4 | 69 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
dan_ackme | 11:ea484e1b7fc4 | 70 | <div id="nav-tree"> |
dan_ackme | 11:ea484e1b7fc4 | 71 | <div id="nav-tree-contents"> |
dan_ackme | 11:ea484e1b7fc4 | 72 | <div id="nav-sync" class="sync"></div> |
dan_ackme | 11:ea484e1b7fc4 | 73 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 74 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 75 | <div id="splitbar" style="-moz-user-select:none;" |
dan_ackme | 11:ea484e1b7fc4 | 76 | class="ui-resizable-handle"> |
dan_ackme | 11:ea484e1b7fc4 | 77 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 78 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 79 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 80 | $(document).ready(function(){initNavTree('group__api__file.html','');}); |
dan_ackme | 11:ea484e1b7fc4 | 81 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 82 | <div id="doc-content"> |
dan_ackme | 11:ea484e1b7fc4 | 83 | <!-- window showing the filter options --> |
dan_ackme | 11:ea484e1b7fc4 | 84 | <div id="MSearchSelectWindow" |
dan_ackme | 11:ea484e1b7fc4 | 85 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 11:ea484e1b7fc4 | 86 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 11:ea484e1b7fc4 | 87 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
dan_ackme | 11:ea484e1b7fc4 | 88 | <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> |
dan_ackme | 11:ea484e1b7fc4 | 89 | |
dan_ackme | 11:ea484e1b7fc4 | 90 | <!-- iframe showing the search results (closed by default) --> |
dan_ackme | 11:ea484e1b7fc4 | 91 | <div id="MSearchResultsWindow"> |
dan_ackme | 11:ea484e1b7fc4 | 92 | <iframe src="javascript:void(0)" frameborder="0" |
dan_ackme | 11:ea484e1b7fc4 | 93 | name="MSearchResults" id="MSearchResults"> |
dan_ackme | 11:ea484e1b7fc4 | 94 | </iframe> |
dan_ackme | 11:ea484e1b7fc4 | 95 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 96 | |
dan_ackme | 11:ea484e1b7fc4 | 97 | <div class="header"> |
dan_ackme | 11:ea484e1b7fc4 | 98 | <div class="summary"> |
dan_ackme | 11:ea484e1b7fc4 | 99 | <a href="#groups">Modules</a> | |
dan_ackme | 11:ea484e1b7fc4 | 100 | <a href="#func-members">Functions</a> </div> |
dan_ackme | 11:ea484e1b7fc4 | 101 | <div class="headertitle"> |
dan_ackme | 11:ea484e1b7fc4 | 102 | <div class="title">File API</div> </div> |
dan_ackme | 11:ea484e1b7fc4 | 103 | </div><!--header--> |
dan_ackme | 11:ea484e1b7fc4 | 104 | <div class="contents"> |
dan_ackme | 11:ea484e1b7fc4 | 105 | |
dan_ackme | 11:ea484e1b7fc4 | 106 | <p>This contains all file API Library methods. |
dan_ackme | 11:ea484e1b7fc4 | 107 | <a href="#details">More...</a></p> |
dan_ackme | 11:ea484e1b7fc4 | 108 | <table class="memberdecls"> |
dan_ackme | 11:ea484e1b7fc4 | 109 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> |
dan_ackme | 11:ea484e1b7fc4 | 110 | Modules</h2></td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 111 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 112 | <tr class="memdesc:group__api__file__macro"><td class="mdescLeft"> </td><td class="mdescRight">API specific macros. <br /></td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 113 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 114 | </table><table class="memberdecls"> |
dan_ackme | 11:ea484e1b7fc4 | 115 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
dan_ackme | 11:ea484e1b7fc4 | 116 | Functions</h2></td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 117 | <tr class="memitem:ga16fb09105975644879eb09581ce486e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga16fb09105975644879eb09581ce486e5"></a> |
dan_ackme | 11:ea484e1b7fc4 | 118 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 119 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 120 | <tr class="separator:ga16fb09105975644879eb09581ce486e5"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 121 | <tr class="memitem:ga4b14d6c68d4d0239e150def385c334a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b14d6c68d4d0239e150def385c334a4"></a> |
dan_ackme | 11:ea484e1b7fc4 | 122 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 123 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 124 | <tr class="separator:ga4b14d6c68d4d0239e150def385c334a4"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 125 | <tr class="memitem:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafcf335cef42b7b3d0fd9d5af70c6ef7d"></a> |
dan_ackme | 11:ea484e1b7fc4 | 126 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 127 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 128 | <tr class="separator:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 129 | <tr class="memitem:ga498cb32c0877b69c2c97365e5c309c46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga498cb32c0877b69c2c97365e5c309c46"></a> |
dan_ackme | 11:ea484e1b7fc4 | 130 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 131 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 132 | <tr class="separator:ga498cb32c0877b69c2c97365e5c309c46"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 133 | <tr class="memitem:ga10536639c61213c037883dade021838f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga10536639c61213c037883dade021838f"></a> |
dan_ackme | 11:ea484e1b7fc4 | 134 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 135 | <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> |
dan_ackme | 11:ea484e1b7fc4 | 136 | <tr class="separator:ga10536639c61213c037883dade021838f"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 137 | </table> |
dan_ackme | 11:ea484e1b7fc4 | 138 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
dan_ackme | 11:ea484e1b7fc4 | 139 | <p>This contains all file API Library methods. </p> |
dan_ackme | 11:ea484e1b7fc4 | 140 | </div><!-- contents --> |
dan_ackme | 11:ea484e1b7fc4 | 141 | </div><!-- doc-content --> |
dan_ackme | 11:ea484e1b7fc4 | 142 | <!-- start footer part --> |
dan_ackme | 11:ea484e1b7fc4 | 143 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
dan_ackme | 11:ea484e1b7fc4 | 144 | <ul> |
dan_ackme | 11:ea484e1b7fc4 | 145 | <li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by |
dan_ackme | 11:ea484e1b7fc4 | 146 | <a href="http://www.doxygen.org/index.html"> |
dan_ackme | 11:ea484e1b7fc4 | 147 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li> |
dan_ackme | 11:ea484e1b7fc4 | 148 | </ul> |
dan_ackme | 11:ea484e1b7fc4 | 149 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 150 | </body> |
dan_ackme | 11:ea484e1b7fc4 | 151 | </html> |