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__macro.html@16:7f1d6d359787, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 04:41:04 2014 -0700
Revision:
16:7f1d6d359787
Parent:
13:2b51f5267c92
Child:
26:8067e3d463d3
updated documentation and copyright

Who changed what in which revision?

UserRevisionLine numberNew 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 13:2b51f5267c92 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 13:2b51f5267c92 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 13:2b51f5267c92 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 11:ea484e1b7fc4 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 11:ea484e1b7fc4 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 11:ea484e1b7fc4 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 11:ea484e1b7fc4 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 11:ea484e1b7fc4 15 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 16 $(document).ready(initResizable);
dan_ackme 11:ea484e1b7fc4 17 $(window).load(resizeHeight);
dan_ackme 11:ea484e1b7fc4 18 </script>
dan_ackme 11:ea484e1b7fc4 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 21 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 23 </script>
dan_ackme 11:ea484e1b7fc4 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 11:ea484e1b7fc4 25 </head>
dan_ackme 11:ea484e1b7fc4 26 <body>
dan_ackme 11:ea484e1b7fc4 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 13:2b51f5267c92 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 13:2b51f5267c92 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 13:2b51f5267c92 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 13:2b51f5267c92 32 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 13:2b51f5267c92 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 13:2b51f5267c92 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 13:2b51f5267c92 36 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 37 </tr>
dan_ackme 13:2b51f5267c92 38 <tr><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 39 </table>
dan_ackme 13:2b51f5267c92 40 </div><!-- 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 13:2b51f5267c92 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 11:ea484e1b7fc4 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 13:2b51f5267c92 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 11:ea484e1b7fc4 52 <li>
dan_ackme 11:ea484e1b7fc4 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 54 <span class="left">
dan_ackme 11:ea484e1b7fc4 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 58 alt=""/>
dan_ackme 11:ea484e1b7fc4 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 63 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 65 </span>
dan_ackme 11:ea484e1b7fc4 66 </div>
dan_ackme 11:ea484e1b7fc4 67 </li>
dan_ackme 11:ea484e1b7fc4 68 </ul>
dan_ackme 11:ea484e1b7fc4 69 </div>
dan_ackme 11:ea484e1b7fc4 70 </div><!-- top -->
dan_ackme 11:ea484e1b7fc4 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 11:ea484e1b7fc4 72 <div id="nav-tree">
dan_ackme 11:ea484e1b7fc4 73 <div id="nav-tree-contents">
dan_ackme 11:ea484e1b7fc4 74 <div id="nav-sync" class="sync"></div>
dan_ackme 11:ea484e1b7fc4 75 </div>
dan_ackme 11:ea484e1b7fc4 76 </div>
dan_ackme 11:ea484e1b7fc4 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 11:ea484e1b7fc4 78 class="ui-resizable-handle">
dan_ackme 11:ea484e1b7fc4 79 </div>
dan_ackme 11:ea484e1b7fc4 80 </div>
dan_ackme 11:ea484e1b7fc4 81 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 82 $(document).ready(function(){initNavTree('group__api__file__macro.html','');});
dan_ackme 11:ea484e1b7fc4 83 </script>
dan_ackme 11:ea484e1b7fc4 84 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 85 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 86 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 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 11:ea484e1b7fc4 91
dan_ackme 11:ea484e1b7fc4 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 93 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 95 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 96 </iframe>
dan_ackme 11:ea484e1b7fc4 97 </div>
dan_ackme 11:ea484e1b7fc4 98
dan_ackme 11:ea484e1b7fc4 99 <div class="header">
dan_ackme 11:ea484e1b7fc4 100 <div class="summary">
dan_ackme 11:ea484e1b7fc4 101 <a href="#define-members">Macros</a> </div>
dan_ackme 11:ea484e1b7fc4 102 <div class="headertitle">
dan_ackme 13:2b51f5267c92 103 <div class="title">Macros<div class="ingroups"><a class="el" href="group__api__file.html">File</a></div></div> </div>
dan_ackme 11:ea484e1b7fc4 104 </div><!--header-->
dan_ackme 11:ea484e1b7fc4 105 <div class="contents">
dan_ackme 11:ea484e1b7fc4 106
dan_ackme 11:ea484e1b7fc4 107 <p>API specific macros.
dan_ackme 11:ea484e1b7fc4 108 <a href="#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 109 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
dan_ackme 11:ea484e1b7fc4 111 Macros</h2></td></tr>
dan_ackme 16:7f1d6d359787 112 <tr class="memitem:gaa124c352091337449140487b9f9db040"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__macro.html#gaa124c352091337449140487b9f9db040">FILE_NAME_MAX_SIZE</a>&#160;&#160;&#160;96</td></tr>
dan_ackme 16:7f1d6d359787 113 <tr class="memdesc:gaa124c352091337449140487b9f9db040"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum filename size of a file on the WiConnect WiFi module filesystem. <a href="#gaa124c352091337449140487b9f9db040">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 114 <tr class="separator:gaa124c352091337449140487b9f9db040"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 115 <tr class="memitem:gac39210b86d0465e494a6d0d56cf8dd05"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac39210b86d0465e494a6d0d56cf8dd05"></a>
dan_ackme 11:ea484e1b7fc4 116 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__macro.html#gac39210b86d0465e494a6d0d56cf8dd05">FILE_MAKE_VERSION</a>(major, minor, patch, rc)&#160;&#160;&#160;((unsigned int)((major) &lt;&lt; 27)|(unsigned int)((minor) &lt;&lt; 21)|(unsigned int)((patch) &lt;&lt; 8)|(unsigned int)((rc) &lt;&lt; 0))</td></tr>
dan_ackme 11:ea484e1b7fc4 117 <tr class="memdesc:gac39210b86d0465e494a6d0d56cf8dd05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combine &lt;<em>major&gt;</em>.&lt;<em>minor&gt;</em>.&lt;<em>patch&gt;</em>.&lt;<em>rc&gt;</em> and create version as a uint32_t. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 118 <tr class="separator:gac39210b86d0465e494a6d0d56cf8dd05"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 119 <tr class="memitem:ga132e94ace044130d574117ac13c7fd24"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga132e94ace044130d574117ac13c7fd24"></a>
dan_ackme 11:ea484e1b7fc4 120 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__macro.html#ga132e94ace044130d574117ac13c7fd24">FILE_VERSION_ARGS</a>(version)&#160;&#160;&#160;(unsigned int)((version &gt;&gt; 27) &amp; 0x1F),(unsigned int)((version &gt;&gt; 21) &amp; 0x3F),(unsigned int)((version &gt;&gt; 8) &amp; 0x1FFF),(unsigned int)(version &amp; 0xFF)</td></tr>
dan_ackme 11:ea484e1b7fc4 121 <tr class="memdesc:ga132e94ace044130d574117ac13c7fd24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a uint32_t <em>version</em>, return arguments for a variable argument function such as printf(). The format string is: d.d.d.d. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 122 <tr class="separator:ga132e94ace044130d574117ac13c7fd24"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 123 </table>
dan_ackme 11:ea484e1b7fc4 124 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 11:ea484e1b7fc4 125 <p>API specific macros. </p>
dan_ackme 16:7f1d6d359787 126 <h2 class="groupheader">Macro Definition Documentation</h2>
dan_ackme 16:7f1d6d359787 127 <a class="anchor" id="gaa124c352091337449140487b9f9db040"></a>
dan_ackme 16:7f1d6d359787 128 <div class="memitem">
dan_ackme 16:7f1d6d359787 129 <div class="memproto">
dan_ackme 16:7f1d6d359787 130 <table class="memname">
dan_ackme 16:7f1d6d359787 131 <tr>
dan_ackme 16:7f1d6d359787 132 <td class="memname">#define FILE_NAME_MAX_SIZE&#160;&#160;&#160;96</td>
dan_ackme 16:7f1d6d359787 133 </tr>
dan_ackme 16:7f1d6d359787 134 </table>
dan_ackme 16:7f1d6d359787 135 </div><div class="memdoc">
dan_ackme 16:7f1d6d359787 136
dan_ackme 16:7f1d6d359787 137 <p>The maximum filename size of a file on the WiConnect WiFi module filesystem. </p>
dan_ackme 16:7f1d6d359787 138 <p>ACKme WiConnect Host Library is licensed under the BSD licence:</p>
dan_ackme 16:7f1d6d359787 139 <p>Copyright (c)2014 ACKme Networks. All rights reserved.</p>
dan_ackme 16:7f1d6d359787 140 <p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
dan_ackme 16:7f1d6d359787 141 <ol type="1">
dan_ackme 16:7f1d6d359787 142 <li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
dan_ackme 16:7f1d6d359787 143 <li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li>
dan_ackme 16:7f1d6d359787 144 <li>The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.</li>
dan_ackme 16:7f1d6d359787 145 </ol>
dan_ackme 16:7f1d6d359787 146 <p>THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </p>
dan_ackme 16:7f1d6d359787 147
dan_ackme 16:7f1d6d359787 148 <p>Definition at line <a class="el" href="_file_interface_8h_source.html#l00040">40</a> of file <a class="el" href="_file_interface_8h_source.html">FileInterface.h</a>.</p>
dan_ackme 16:7f1d6d359787 149
dan_ackme 16:7f1d6d359787 150 </div>
dan_ackme 16:7f1d6d359787 151 </div>
dan_ackme 11:ea484e1b7fc4 152 </div><!-- contents -->
dan_ackme 11:ea484e1b7fc4 153 </div><!-- doc-content -->
dan_ackme 11:ea484e1b7fc4 154 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 11:ea484e1b7fc4 155 <ul>
dan_ackme 13:2b51f5267c92 156 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 11:ea484e1b7fc4 157 </ul>
dan_ackme 11:ea484e1b7fc4 158 </div>
dan_ackme 11:ea484e1b7fc4 159 </body>
dan_ackme 13:2b51f5267c92 160 </html>