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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 16:7f1d6d359787 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 16:7f1d6d359787 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 16:7f1d6d359787 3 <head>
dan_ackme 16:7f1d6d359787 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 16:7f1d6d359787 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 16:7f1d6d359787 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 16:7f1d6d359787 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 16:7f1d6d359787 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 16:7f1d6d359787 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 16:7f1d6d359787 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 16:7f1d6d359787 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 16:7f1d6d359787 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 16:7f1d6d359787 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 16:7f1d6d359787 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 16:7f1d6d359787 15 <script type="text/javascript">
dan_ackme 16:7f1d6d359787 16 $(document).ready(initResizable);
dan_ackme 16:7f1d6d359787 17 $(window).load(resizeHeight);
dan_ackme 16:7f1d6d359787 18 </script>
dan_ackme 16:7f1d6d359787 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 16:7f1d6d359787 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 16:7f1d6d359787 21 <script type="text/javascript">
dan_ackme 16:7f1d6d359787 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 16:7f1d6d359787 23 </script>
dan_ackme 16:7f1d6d359787 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 16:7f1d6d359787 25 </head>
dan_ackme 16:7f1d6d359787 26 <body>
dan_ackme 16:7f1d6d359787 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 16:7f1d6d359787 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 16:7f1d6d359787 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 16:7f1d6d359787 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 16:7f1d6d359787 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 16:7f1d6d359787 32 <td style="width:20px"></td>
dan_ackme 16:7f1d6d359787 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 16:7f1d6d359787 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 16:7f1d6d359787 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 16:7f1d6d359787 36 <td style="width:20px"></td>
dan_ackme 16:7f1d6d359787 37 </tr>
dan_ackme 16:7f1d6d359787 38 <tr><td>&nbsp;</td></tr>
dan_ackme 16:7f1d6d359787 39 </table>
dan_ackme 16:7f1d6d359787 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 16:7f1d6d359787 41 <script type="text/javascript">
dan_ackme 16:7f1d6d359787 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 16:7f1d6d359787 43 </script>
dan_ackme 16:7f1d6d359787 44 <div id="navrow1" class="tabs">
dan_ackme 16:7f1d6d359787 45 <ul class="tablist">
dan_ackme 16:7f1d6d359787 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 16:7f1d6d359787 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 16:7f1d6d359787 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 16:7f1d6d359787 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 16:7f1d6d359787 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 16:7f1d6d359787 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 16:7f1d6d359787 52 <li>
dan_ackme 16:7f1d6d359787 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 16:7f1d6d359787 54 <span class="left">
dan_ackme 16:7f1d6d359787 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 16:7f1d6d359787 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 16:7f1d6d359787 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 16:7f1d6d359787 58 alt=""/>
dan_ackme 16:7f1d6d359787 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 16:7f1d6d359787 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 16:7f1d6d359787 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 16:7f1d6d359787 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 16:7f1d6d359787 63 </span><span class="right">
dan_ackme 16:7f1d6d359787 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 16:7f1d6d359787 65 </span>
dan_ackme 16:7f1d6d359787 66 </div>
dan_ackme 16:7f1d6d359787 67 </li>
dan_ackme 16:7f1d6d359787 68 </ul>
dan_ackme 16:7f1d6d359787 69 </div>
dan_ackme 16:7f1d6d359787 70 <div id="navrow2" class="tabs2">
dan_ackme 16:7f1d6d359787 71 <ul class="tablist">
dan_ackme 16:7f1d6d359787 72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 16:7f1d6d359787 73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 16:7f1d6d359787 74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 16:7f1d6d359787 75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 16:7f1d6d359787 76 </ul>
dan_ackme 16:7f1d6d359787 77 </div>
dan_ackme 16:7f1d6d359787 78 </div><!-- top -->
dan_ackme 16:7f1d6d359787 79 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 16:7f1d6d359787 80 <div id="nav-tree">
dan_ackme 16:7f1d6d359787 81 <div id="nav-tree-contents">
dan_ackme 16:7f1d6d359787 82 <div id="nav-sync" class="sync"></div>
dan_ackme 16:7f1d6d359787 83 </div>
dan_ackme 16:7f1d6d359787 84 </div>
dan_ackme 16:7f1d6d359787 85 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 16:7f1d6d359787 86 class="ui-resizable-handle">
dan_ackme 16:7f1d6d359787 87 </div>
dan_ackme 16:7f1d6d359787 88 </div>
dan_ackme 16:7f1d6d359787 89 <script type="text/javascript">
dan_ackme 16:7f1d6d359787 90 $(document).ready(function(){initNavTree('class_string_util.html','');});
dan_ackme 16:7f1d6d359787 91 </script>
dan_ackme 16:7f1d6d359787 92 <div id="doc-content">
dan_ackme 16:7f1d6d359787 93 <!-- window showing the filter options -->
dan_ackme 16:7f1d6d359787 94 <div id="MSearchSelectWindow"
dan_ackme 16:7f1d6d359787 95 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 16:7f1d6d359787 96 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 16:7f1d6d359787 97 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 16:7f1d6d359787 98 <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 16:7f1d6d359787 99
dan_ackme 16:7f1d6d359787 100 <!-- iframe showing the search results (closed by default) -->
dan_ackme 16:7f1d6d359787 101 <div id="MSearchResultsWindow">
dan_ackme 16:7f1d6d359787 102 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 16:7f1d6d359787 103 name="MSearchResults" id="MSearchResults">
dan_ackme 16:7f1d6d359787 104 </iframe>
dan_ackme 16:7f1d6d359787 105 </div>
dan_ackme 16:7f1d6d359787 106
dan_ackme 16:7f1d6d359787 107 <div class="header">
dan_ackme 16:7f1d6d359787 108 <div class="summary">
dan_ackme 16:7f1d6d359787 109 <a href="class_string_util-members.html">List of all members</a> </div>
dan_ackme 16:7f1d6d359787 110 <div class="headertitle">
dan_ackme 16:7f1d6d359787 111 <div class="title">StringUtil Class Reference</div> </div>
dan_ackme 16:7f1d6d359787 112 </div><!--header-->
dan_ackme 16:7f1d6d359787 113 <div class="contents">
dan_ackme 16:7f1d6d359787 114
dan_ackme 16:7f1d6d359787 115 <p><code>#include &lt;<a class="el" href="_string_util_8h_source.html">StringUtil.h</a>&gt;</code></p>
dan_ackme 16:7f1d6d359787 116 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 16:7f1d6d359787 117 <div class="textblock"><p>ACKme WiConnect Host Library is licensed under the BSD licence:</p>
dan_ackme 16:7f1d6d359787 118 <p>Copyright (c)2014 ACKme Networks. All rights reserved.</p>
dan_ackme 16:7f1d6d359787 119 <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 120 <ol type="1">
dan_ackme 16:7f1d6d359787 121 <li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
dan_ackme 16:7f1d6d359787 122 <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 123 <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 124 </ol>
dan_ackme 16:7f1d6d359787 125 <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 126
dan_ackme 16:7f1d6d359787 127 <p>Definition at line <a class="el" href="_string_util_8h_source.html#l00045">45</a> of file <a class="el" href="_string_util_8h_source.html">StringUtil.h</a>.</p>
dan_ackme 16:7f1d6d359787 128 </div><hr/>The documentation for this class was generated from the following file:<ul>
dan_ackme 16:7f1d6d359787 129 <li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/<a class="el" href="_string_util_8h_source.html">StringUtil.h</a></li>
dan_ackme 16:7f1d6d359787 130 </ul>
dan_ackme 16:7f1d6d359787 131 </div><!-- contents -->
dan_ackme 16:7f1d6d359787 132 </div><!-- doc-content -->
dan_ackme 16:7f1d6d359787 133 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 16:7f1d6d359787 134 <ul>
dan_ackme 16:7f1d6d359787 135 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 16:7f1d6d359787 136 </ul>
dan_ackme 16:7f1d6d359787 137 </div>
dan_ackme 16:7f1d6d359787 138 </body>
dan_ackme 16:7f1d6d359787 139 </html>