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__methods.html
- Revision:
- 17:7268f365676b
- Parent:
- 14:85a2ed029f37
- Child:
- 26:8067e3d463d3
diff -r 7f1d6d359787 -r 7268f365676b doc/html/group__api__file__methods.html --- a/doc/html/group__api__file__methods.html Wed Aug 13 04:41:04 2014 -0700 +++ b/doc/html/group__api__file__methods.html Sat Aug 23 05:39:17 2014 -0700 @@ -112,15 +112,15 @@ <tr class="memitem:ga16fb09105975644879eb09581ce486e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &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> <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 filesystem. <a href="#ga16fb09105975644879eb09581ce486e5">More...</a><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="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.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 filesystem for reading. <a href="#ga4b14d6c68d4d0239e150def385c334a4">More...</a><br /></td></tr> -<tr class="separator:ga4b14d6c68d4d0239e150def385c334a4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaf2977c691be09aeda102267a6769583"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &file, const char *name)</td></tr> +<tr class="memdesc:gaaf2977c691be09aeda102267a6769583"><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 filesystem for reading. <a href="#gaaf2977c691be09aeda102267a6769583">More...</a><br /></td></tr> +<tr class="separator:gaaf2977c691be09aeda102267a6769583"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> <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 filesystem. <a href="#gafcf335cef42b7b3d0fd9d5af70c6ef7d">More...</a><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="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.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 filesystem. <a href="#ga498cb32c0877b69c2c97365e5c309c46">More...</a><br /></td></tr> -<tr class="separator:ga498cb32c0877b69c2c97365e5c309c46"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &file)</td></tr> +<tr class="memdesc:gaa9ea2d05871ee7e7bbfa360b86fefb20"><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 filesystem. <a href="#gaa9ea2d05871ee7e7bbfa360b86fefb20">More...</a><br /></td></tr> +<tr class="separator:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga10536639c61213c037883dade021838f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> &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> <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 filesystem. <a href="#ga10536639c61213c037883dade021838f">More...</a><br /></td></tr> <tr class="separator:ga10536639c61213c037883dade021838f"><td class="memSeparator" colspan="2"> </td></tr> @@ -233,14 +233,14 @@ </div> </div> -<a class="anchor" id="ga498cb32c0877b69c2c97365e5c309c46"></a> +<a class="anchor" id="gaa9ea2d05871ee7e7bbfa360b86fefb20"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::deleteFile </td> <td>(</td> - <td class="paramtype">const <a class="el" href="classwiconnect_1_1_file.html">File</a> & </td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> & </td> <td class="paramname"><em>file</em></td><td>)</td> <td></td> </tr> @@ -250,7 +250,7 @@ <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> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>The <a class="el" href="classwiconnect_1_1_file.html">File</a> object of the file to delete </td></tr> + <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> </table> </dd> </dl> @@ -305,14 +305,14 @@ </div> </div> -<a class="anchor" id="ga4b14d6c68d4d0239e150def385c334a4"></a> +<a class="anchor" id="gaaf2977c691be09aeda102267a6769583"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::FileInterface::openFile </td> <td>(</td> - <td class="paramtype"><a class="el" href="classwiconnect_1_1_file.html">File</a> & </td> + <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> & </td> <td class="paramname"><em>file</em>, </td> </tr> <tr> @@ -330,10 +330,10 @@ </div><div class="memdoc"> <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> -<p>Once opened, the returned <a class="el" href="classwiconnect_1_1_file.html">File</a> object may only be read.</p> +<p>Once opened, the returned <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> object may only be read.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">file</td><td>The <a class="el" href="classwiconnect_1_1_file.html">File</a> object to read data from </td></tr> + <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> <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the file to open </td></tr> </table> </dd>