ACKme / WiConnect

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__methods.html@17:7268f365676b, 2014-08-23 (annotated)

Committer:
dan_ackme
Date:
Sat Aug 23 05:39:17 2014 -0700
Revision:
17:7268f365676b
Parent:
14:85a2ed029f37
Child:
26:8067e3d463d3
Fixes and documentation updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 14:85a2ed029f37 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 14:85a2ed029f37 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 14:85a2ed029f37 3 <head>
dan_ackme 14:85a2ed029f37 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 14:85a2ed029f37 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 14:85a2ed029f37 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 14:85a2ed029f37 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 14:85a2ed029f37 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 14:85a2ed029f37 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 14:85a2ed029f37 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 14:85a2ed029f37 15 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 16 $(document).ready(initResizable);
dan_ackme 14:85a2ed029f37 17 $(window).load(resizeHeight);
dan_ackme 14:85a2ed029f37 18 </script>
dan_ackme 14:85a2ed029f37 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 14:85a2ed029f37 21 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 14:85a2ed029f37 23 </script>
dan_ackme 14:85a2ed029f37 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 14:85a2ed029f37 25 </head>
dan_ackme 14:85a2ed029f37 26 <body>
dan_ackme 14:85a2ed029f37 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 14:85a2ed029f37 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 14:85a2ed029f37 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 14:85a2ed029f37 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 14:85a2ed029f37 32 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 14:85a2ed029f37 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 14:85a2ed029f37 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 14:85a2ed029f37 36 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 37 </tr>
dan_ackme 14:85a2ed029f37 38 <tr><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 39 </table>
dan_ackme 14:85a2ed029f37 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 14:85a2ed029f37 41 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 14:85a2ed029f37 43 </script>
dan_ackme 14:85a2ed029f37 44 <div id="navrow1" class="tabs">
dan_ackme 14:85a2ed029f37 45 <ul class="tablist">
dan_ackme 14:85a2ed029f37 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 14:85a2ed029f37 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 14:85a2ed029f37 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 14:85a2ed029f37 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 14:85a2ed029f37 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 14:85a2ed029f37 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 14:85a2ed029f37 52 <li>
dan_ackme 14:85a2ed029f37 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 14:85a2ed029f37 54 <span class="left">
dan_ackme 14:85a2ed029f37 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 14:85a2ed029f37 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 58 alt=""/>
dan_ackme 14:85a2ed029f37 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 14:85a2ed029f37 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 14:85a2ed029f37 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 14:85a2ed029f37 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 14:85a2ed029f37 63 </span><span class="right">
dan_ackme 14:85a2ed029f37 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 14:85a2ed029f37 65 </span>
dan_ackme 14:85a2ed029f37 66 </div>
dan_ackme 14:85a2ed029f37 67 </li>
dan_ackme 14:85a2ed029f37 68 </ul>
dan_ackme 14:85a2ed029f37 69 </div>
dan_ackme 14:85a2ed029f37 70 </div><!-- top -->
dan_ackme 14:85a2ed029f37 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 72 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 73 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 74 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 75 </div>
dan_ackme 14:85a2ed029f37 76 </div>
dan_ackme 14:85a2ed029f37 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 78 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 79 </div>
dan_ackme 14:85a2ed029f37 80 </div>
dan_ackme 14:85a2ed029f37 81 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 82 $(document).ready(function(){initNavTree('group__api__file__methods.html','');});
dan_ackme 14:85a2ed029f37 83 </script>
dan_ackme 14:85a2ed029f37 84 <div id="doc-content">
dan_ackme 14:85a2ed029f37 85 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 86 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 90 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 14:85a2ed029f37 91
dan_ackme 14:85a2ed029f37 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 93 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 95 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 96 </iframe>
dan_ackme 14:85a2ed029f37 97 </div>
dan_ackme 14:85a2ed029f37 98
dan_ackme 14:85a2ed029f37 99 <div class="header">
dan_ackme 14:85a2ed029f37 100 <div class="summary">
dan_ackme 14:85a2ed029f37 101 <a href="#func-members">Functions</a> </div>
dan_ackme 14:85a2ed029f37 102 <div class="headertitle">
dan_ackme 14:85a2ed029f37 103 <div class="title">Methods<div class="ingroups"><a class="el" href="group__api__file.html">File</a></div></div> </div>
dan_ackme 14:85a2ed029f37 104 </div><!--header-->
dan_ackme 14:85a2ed029f37 105 <div class="contents">
dan_ackme 14:85a2ed029f37 106
dan_ackme 14:85a2ed029f37 107 <p>File Types.
dan_ackme 14:85a2ed029f37 108 <a href="#details">More...</a></p>
dan_ackme 14:85a2ed029f37 109 <table class="memberdecls">
dan_ackme 14:85a2ed029f37 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 14:85a2ed029f37 111 Functions</h2></td></tr>
dan_ackme 14:85a2ed029f37 112 <tr class="memitem:ga16fb09105975644879eb09581ce486e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#ga16fb09105975644879eb09581ce486e5">wiconnect::FileInterface::createFile</a> (const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &amp;reader, void *user, const char *name, uint32_t size, uint32_t version=0, <a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</td></tr>
dan_ackme 14:85a2ed029f37 113 <tr class="memdesc:ga16fb09105975644879eb09581ce486e5"><td class="mdescLeft">&#160;</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 filesystem. <a href="#ga16fb09105975644879eb09581ce486e5">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 114 <tr class="separator:ga16fb09105975644879eb09581ce486e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 17:7268f365676b 115 <tr class="memitem:gaaf2977c691be09aeda102267a6769583"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#gaaf2977c691be09aeda102267a6769583">wiconnect::FileInterface::openFile</a> (<a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> &amp;file, const char *name)</td></tr>
dan_ackme 17:7268f365676b 116 <tr class="memdesc:gaaf2977c691be09aeda102267a6769583"><td class="mdescLeft">&#160;</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 filesystem for reading. <a href="#gaaf2977c691be09aeda102267a6769583">More...</a><br /></td></tr>
dan_ackme 17:7268f365676b 117 <tr class="separator:gaaf2977c691be09aeda102267a6769583"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 118 <tr class="memitem:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">wiconnect::FileInterface::deleteFile</a> (const char *name)</td></tr>
dan_ackme 14:85a2ed029f37 119 <tr class="memdesc:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="mdescLeft">&#160;</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 filesystem. <a href="#gafcf335cef42b7b3d0fd9d5af70c6ef7d">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 120 <tr class="separator:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 17:7268f365676b 121 <tr class="memitem:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#gaa9ea2d05871ee7e7bbfa360b86fefb20">wiconnect::FileInterface::deleteFile</a> (const <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> &amp;file)</td></tr>
dan_ackme 17:7268f365676b 122 <tr class="memdesc:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="mdescLeft">&#160;</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 filesystem. <a href="#gaa9ea2d05871ee7e7bbfa360b86fefb20">More...</a><br /></td></tr>
dan_ackme 17:7268f365676b 123 <tr class="separator:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 124 <tr class="memitem:ga10536639c61213c037883dade021838f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">wiconnect::FileInterface::listFiles</a> (<a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> &amp;list, const char *name=NULL, <a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, uint32_t version=0)</td></tr>
dan_ackme 14:85a2ed029f37 125 <tr class="memdesc:ga10536639c61213c037883dade021838f"><td class="mdescLeft">&#160;</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 filesystem. <a href="#ga10536639c61213c037883dade021838f">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 126 <tr class="separator:ga10536639c61213c037883dade021838f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 127 </table>
dan_ackme 14:85a2ed029f37 128 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 14:85a2ed029f37 129 <p>File Types. </p>
dan_ackme 14:85a2ed029f37 130 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 14:85a2ed029f37 131 <a class="anchor" id="ga16fb09105975644879eb09581ce486e5"></a>
dan_ackme 14:85a2ed029f37 132 <div class="memitem">
dan_ackme 14:85a2ed029f37 133 <div class="memproto">
dan_ackme 14:85a2ed029f37 134 <table class="memname">
dan_ackme 14:85a2ed029f37 135 <tr>
dan_ackme 14:85a2ed029f37 136 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::createFile </td>
dan_ackme 14:85a2ed029f37 137 <td>(</td>
dan_ackme 14:85a2ed029f37 138 <td class="paramtype">const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &amp;&#160;</td>
dan_ackme 14:85a2ed029f37 139 <td class="paramname"><em>reader</em>, </td>
dan_ackme 14:85a2ed029f37 140 </tr>
dan_ackme 14:85a2ed029f37 141 <tr>
dan_ackme 14:85a2ed029f37 142 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 143 <td></td>
dan_ackme 14:85a2ed029f37 144 <td class="paramtype">void *&#160;</td>
dan_ackme 14:85a2ed029f37 145 <td class="paramname"><em>user</em>, </td>
dan_ackme 14:85a2ed029f37 146 </tr>
dan_ackme 14:85a2ed029f37 147 <tr>
dan_ackme 14:85a2ed029f37 148 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 149 <td></td>
dan_ackme 14:85a2ed029f37 150 <td class="paramtype">const char *&#160;</td>
dan_ackme 14:85a2ed029f37 151 <td class="paramname"><em>name</em>, </td>
dan_ackme 14:85a2ed029f37 152 </tr>
dan_ackme 14:85a2ed029f37 153 <tr>
dan_ackme 14:85a2ed029f37 154 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 155 <td></td>
dan_ackme 14:85a2ed029f37 156 <td class="paramtype">uint32_t&#160;</td>
dan_ackme 14:85a2ed029f37 157 <td class="paramname"><em>size</em>, </td>
dan_ackme 14:85a2ed029f37 158 </tr>
dan_ackme 14:85a2ed029f37 159 <tr>
dan_ackme 14:85a2ed029f37 160 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 161 <td></td>
dan_ackme 14:85a2ed029f37 162 <td class="paramtype">uint32_t&#160;</td>
dan_ackme 14:85a2ed029f37 163 <td class="paramname"><em>version</em> = <code>0</code>, </td>
dan_ackme 14:85a2ed029f37 164 </tr>
dan_ackme 14:85a2ed029f37 165 <tr>
dan_ackme 14:85a2ed029f37 166 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 167 <td></td>
dan_ackme 14:85a2ed029f37 168 <td class="paramtype"><a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a>&#160;</td>
dan_ackme 14:85a2ed029f37 169 <td class="paramname"><em>type</em> = <code>FILE_TYPE_ANY</code>, </td>
dan_ackme 14:85a2ed029f37 170 </tr>
dan_ackme 14:85a2ed029f37 171 <tr>
dan_ackme 14:85a2ed029f37 172 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 173 <td></td>
dan_ackme 14:85a2ed029f37 174 <td class="paramtype">bool&#160;</td>
dan_ackme 14:85a2ed029f37 175 <td class="paramname"><em>isEssential</em> = <code>false</code>, </td>
dan_ackme 14:85a2ed029f37 176 </tr>
dan_ackme 14:85a2ed029f37 177 <tr>
dan_ackme 14:85a2ed029f37 178 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 179 <td></td>
dan_ackme 14:85a2ed029f37 180 <td class="paramtype">int32_t&#160;</td>
dan_ackme 14:85a2ed029f37 181 <td class="paramname"><em>checksum</em> = <code>-1</code>&#160;</td>
dan_ackme 14:85a2ed029f37 182 </tr>
dan_ackme 14:85a2ed029f37 183 <tr>
dan_ackme 14:85a2ed029f37 184 <td></td>
dan_ackme 14:85a2ed029f37 185 <td>)</td>
dan_ackme 14:85a2ed029f37 186 <td></td><td></td>
dan_ackme 14:85a2ed029f37 187 </tr>
dan_ackme 14:85a2ed029f37 188 </table>
dan_ackme 14:85a2ed029f37 189 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 190
dan_ackme 14:85a2ed029f37 191 <p>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 filesystem. </p>
dan_ackme 14:85a2ed029f37 192 <p>This creates a file on the module's filesystem. The file's name and size are required. Optionally specify the version, type and if it's essential (i.e. if it should never be automatically deleted, careful with this optional as it could cause the the module to not be able to update its firmware).</p>
dan_ackme 14:85a2ed029f37 193 <p>When this method is executed, the file is created on the module then the 'reader' parameter callback is called until all the file data is read from the HOST and written to the module file.</p>
dan_ackme 14:85a2ed029f37 194 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 14:85a2ed029f37 195 <table class="params">
dan_ackme 14:85a2ed029f37 196 <tr><td class="paramdir">[in]</td><td class="paramname">reader</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> to be executed until all file data has been read from the HOST and written to the module </td></tr>
dan_ackme 14:85a2ed029f37 197 <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>This is supplied to the <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> callback. It is not used by the library. Leave NULL if not needed. </td></tr>
dan_ackme 14:85a2ed029f37 198 <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the file to create </td></tr>
dan_ackme 14:85a2ed029f37 199 <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size in bytes of the file </td></tr>
dan_ackme 14:85a2ed029f37 200 <tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>Optional, the version of the file, defaults to 1.0.0.0 </td></tr>
dan_ackme 14:85a2ed029f37 201 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Optional, the file type, defaults to FILE_TYPE_MISC_FIX_LEN </td></tr>
dan_ackme 14:85a2ed029f37 202 <tr><td class="paramdir">[in]</td><td class="paramname">isEssential</td><td>Optional, specify if the file should never be automatically deleted during a firmware upgrade </td></tr>
dan_ackme 14:85a2ed029f37 203 <tr><td class="paramdir">[in]</td><td class="paramname">checksum</td><td>The CRC16 checksum of the file data. The module verifies the written data against this checksum </td></tr>
dan_ackme 14:85a2ed029f37 204 </table>
dan_ackme 14:85a2ed029f37 205 </dd>
dan_ackme 14:85a2ed029f37 206 </dl>
dan_ackme 14:85a2ed029f37 207 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 14:85a2ed029f37 208
dan_ackme 14:85a2ed029f37 209 </div>
dan_ackme 14:85a2ed029f37 210 </div>
dan_ackme 14:85a2ed029f37 211 <a class="anchor" id="gafcf335cef42b7b3d0fd9d5af70c6ef7d"></a>
dan_ackme 14:85a2ed029f37 212 <div class="memitem">
dan_ackme 14:85a2ed029f37 213 <div class="memproto">
dan_ackme 14:85a2ed029f37 214 <table class="memname">
dan_ackme 14:85a2ed029f37 215 <tr>
dan_ackme 14:85a2ed029f37 216 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::deleteFile </td>
dan_ackme 14:85a2ed029f37 217 <td>(</td>
dan_ackme 14:85a2ed029f37 218 <td class="paramtype">const char *&#160;</td>
dan_ackme 14:85a2ed029f37 219 <td class="paramname"><em>name</em></td><td>)</td>
dan_ackme 14:85a2ed029f37 220 <td></td>
dan_ackme 14:85a2ed029f37 221 </tr>
dan_ackme 14:85a2ed029f37 222 </table>
dan_ackme 14:85a2ed029f37 223 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 224
dan_ackme 14:85a2ed029f37 225 <p>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 filesystem. </p>
dan_ackme 14:85a2ed029f37 226 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 14:85a2ed029f37 227 <table class="params">
dan_ackme 14:85a2ed029f37 228 <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the file to delete </td></tr>
dan_ackme 14:85a2ed029f37 229 </table>
dan_ackme 14:85a2ed029f37 230 </dd>
dan_ackme 14:85a2ed029f37 231 </dl>
dan_ackme 14:85a2ed029f37 232 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 14:85a2ed029f37 233
dan_ackme 14:85a2ed029f37 234 </div>
dan_ackme 14:85a2ed029f37 235 </div>
dan_ackme 17:7268f365676b 236 <a class="anchor" id="gaa9ea2d05871ee7e7bbfa360b86fefb20"></a>
dan_ackme 14:85a2ed029f37 237 <div class="memitem">
dan_ackme 14:85a2ed029f37 238 <div class="memproto">
dan_ackme 14:85a2ed029f37 239 <table class="memname">
dan_ackme 14:85a2ed029f37 240 <tr>
dan_ackme 14:85a2ed029f37 241 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::deleteFile </td>
dan_ackme 14:85a2ed029f37 242 <td>(</td>
dan_ackme 17:7268f365676b 243 <td class="paramtype">const <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> &amp;&#160;</td>
dan_ackme 14:85a2ed029f37 244 <td class="paramname"><em>file</em></td><td>)</td>
dan_ackme 14:85a2ed029f37 245 <td></td>
dan_ackme 14:85a2ed029f37 246 </tr>
dan_ackme 14:85a2ed029f37 247 </table>
dan_ackme 14:85a2ed029f37 248 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 249
dan_ackme 14:85a2ed029f37 250 <p>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 filesystem. </p>
dan_ackme 14:85a2ed029f37 251 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 14:85a2ed029f37 252 <table class="params">
dan_ackme 17:7268f365676b 253 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>The <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> object of the file to delete </td></tr>
dan_ackme 14:85a2ed029f37 254 </table>
dan_ackme 14:85a2ed029f37 255 </dd>
dan_ackme 14:85a2ed029f37 256 </dl>
dan_ackme 14:85a2ed029f37 257 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 14:85a2ed029f37 258
dan_ackme 14:85a2ed029f37 259 </div>
dan_ackme 14:85a2ed029f37 260 </div>
dan_ackme 14:85a2ed029f37 261 <a class="anchor" id="ga10536639c61213c037883dade021838f"></a>
dan_ackme 14:85a2ed029f37 262 <div class="memitem">
dan_ackme 14:85a2ed029f37 263 <div class="memproto">
dan_ackme 14:85a2ed029f37 264 <table class="memname">
dan_ackme 14:85a2ed029f37 265 <tr>
dan_ackme 14:85a2ed029f37 266 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::listFiles </td>
dan_ackme 14:85a2ed029f37 267 <td>(</td>
dan_ackme 14:85a2ed029f37 268 <td class="paramtype"><a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> &amp;&#160;</td>
dan_ackme 14:85a2ed029f37 269 <td class="paramname"><em>list</em>, </td>
dan_ackme 14:85a2ed029f37 270 </tr>
dan_ackme 14:85a2ed029f37 271 <tr>
dan_ackme 14:85a2ed029f37 272 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 273 <td></td>
dan_ackme 14:85a2ed029f37 274 <td class="paramtype">const char *&#160;</td>
dan_ackme 14:85a2ed029f37 275 <td class="paramname"><em>name</em> = <code>NULL</code>, </td>
dan_ackme 14:85a2ed029f37 276 </tr>
dan_ackme 14:85a2ed029f37 277 <tr>
dan_ackme 14:85a2ed029f37 278 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 279 <td></td>
dan_ackme 14:85a2ed029f37 280 <td class="paramtype"><a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a>&#160;</td>
dan_ackme 14:85a2ed029f37 281 <td class="paramname"><em>type</em> = <code>FILE_TYPE_ANY</code>, </td>
dan_ackme 14:85a2ed029f37 282 </tr>
dan_ackme 14:85a2ed029f37 283 <tr>
dan_ackme 14:85a2ed029f37 284 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 285 <td></td>
dan_ackme 14:85a2ed029f37 286 <td class="paramtype">uint32_t&#160;</td>
dan_ackme 14:85a2ed029f37 287 <td class="paramname"><em>version</em> = <code>0</code>&#160;</td>
dan_ackme 14:85a2ed029f37 288 </tr>
dan_ackme 14:85a2ed029f37 289 <tr>
dan_ackme 14:85a2ed029f37 290 <td></td>
dan_ackme 14:85a2ed029f37 291 <td>)</td>
dan_ackme 14:85a2ed029f37 292 <td></td><td></td>
dan_ackme 14:85a2ed029f37 293 </tr>
dan_ackme 14:85a2ed029f37 294 </table>
dan_ackme 14:85a2ed029f37 295 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 296
dan_ackme 14:85a2ed029f37 297 <p>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 filesystem. </p>
dan_ackme 14:85a2ed029f37 298 <p>This lists all the files on the filesystem. Optionally filter by one or more parameters:</p><ul>
dan_ackme 14:85a2ed029f37 299 <li>name - list files only with given name. If the name started with the wildcard character '*', then only the characters after it are used for filter. Example: <div class="fragment"><div class="line">wiconnect.<a class="code" href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">listFiles</a>(fileList, <span class="stringliteral">&quot;*.txt&quot;</span>); <span class="comment">// only list files with &#39;.txt&#39; extension</span></div>
dan_ackme 14:85a2ed029f37 300 </div><!-- fragment --></li>
dan_ackme 14:85a2ed029f37 301 <li>type - only list files with given type</li>
dan_ackme 14:85a2ed029f37 302 <li>version - only list file with given version <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 14:85a2ed029f37 303 </li>
dan_ackme 14:85a2ed029f37 304 </ul>
dan_ackme 14:85a2ed029f37 305
dan_ackme 14:85a2ed029f37 306 </div>
dan_ackme 14:85a2ed029f37 307 </div>
dan_ackme 17:7268f365676b 308 <a class="anchor" id="gaaf2977c691be09aeda102267a6769583"></a>
dan_ackme 14:85a2ed029f37 309 <div class="memitem">
dan_ackme 14:85a2ed029f37 310 <div class="memproto">
dan_ackme 14:85a2ed029f37 311 <table class="memname">
dan_ackme 14:85a2ed029f37 312 <tr>
dan_ackme 14:85a2ed029f37 313 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::openFile </td>
dan_ackme 14:85a2ed029f37 314 <td>(</td>
dan_ackme 17:7268f365676b 315 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> &amp;&#160;</td>
dan_ackme 14:85a2ed029f37 316 <td class="paramname"><em>file</em>, </td>
dan_ackme 14:85a2ed029f37 317 </tr>
dan_ackme 14:85a2ed029f37 318 <tr>
dan_ackme 14:85a2ed029f37 319 <td class="paramkey"></td>
dan_ackme 14:85a2ed029f37 320 <td></td>
dan_ackme 14:85a2ed029f37 321 <td class="paramtype">const char *&#160;</td>
dan_ackme 14:85a2ed029f37 322 <td class="paramname"><em>name</em>&#160;</td>
dan_ackme 14:85a2ed029f37 323 </tr>
dan_ackme 14:85a2ed029f37 324 <tr>
dan_ackme 14:85a2ed029f37 325 <td></td>
dan_ackme 14:85a2ed029f37 326 <td>)</td>
dan_ackme 14:85a2ed029f37 327 <td></td><td></td>
dan_ackme 14:85a2ed029f37 328 </tr>
dan_ackme 14:85a2ed029f37 329 </table>
dan_ackme 14:85a2ed029f37 330 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 331
dan_ackme 14:85a2ed029f37 332 <p>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 filesystem for reading. </p>
dan_ackme 17:7268f365676b 333 <p>Once opened, the returned <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> object may only be read.</p>
dan_ackme 14:85a2ed029f37 334 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 14:85a2ed029f37 335 <table class="params">
dan_ackme 17:7268f365676b 336 <tr><td class="paramdir">[out]</td><td class="paramname">file</td><td>The <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> object to read data from </td></tr>
dan_ackme 14:85a2ed029f37 337 <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the file to open </td></tr>
dan_ackme 14:85a2ed029f37 338 </table>
dan_ackme 14:85a2ed029f37 339 </dd>
dan_ackme 14:85a2ed029f37 340 </dl>
dan_ackme 14:85a2ed029f37 341 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 14:85a2ed029f37 342
dan_ackme 14:85a2ed029f37 343 </div>
dan_ackme 14:85a2ed029f37 344 </div>
dan_ackme 14:85a2ed029f37 345 </div><!-- contents -->
dan_ackme 14:85a2ed029f37 346 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 347 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 348 <ul>
dan_ackme 14:85a2ed029f37 349 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 350 </ul>
dan_ackme 14:85a2ed029f37 351 </div>
dan_ackme 14:85a2ed029f37 352 </body>
dan_ackme 14:85a2ed029f37 353 </html>