| 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 |
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> </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> </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 Overview</span></a></li>
|
| dan_ackme |
13:2b51f5267c92
|
47
|
<li><a href="modules.html"><span>Library API</span></a></li>
|
| dan_ackme |
13:2b51f5267c92
|
48
|
<li><a href="examples.html"><span>API 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 Reference Manual</span></a></li>
|
| dan_ackme |
13:2b51f5267c92
|
51
|
<li><a href="http://www.ack.me/WiConnect"><span>ACKme 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__core__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"> </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
|
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__core.html">Core</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 |
13:2b51f5267c92
|
107
|
<p>Core 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 |
11:ea484e1b7fc4
|
112
|
<tr class="memitem:ga74e75242132eaabbc1c512488a135926"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga74e75242132eaabbc1c512488a135926"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
113
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga74e75242132eaabbc1c512488a135926">MIN</a>(x, y)   ((x) < (y) ? (x) : (y))</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
114
|
<tr class="memdesc:ga74e75242132eaabbc1c512488a135926"><td class="mdescLeft"> </td><td class="mdescRight">Computes the minimum of <em>x</em> and <em>y</em>. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
115
|
<tr class="separator:ga74e75242132eaabbc1c512488a135926"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
116
|
<tr class="memitem:gaacc3ee1a7f283f8ef65cea31f4436a95"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaacc3ee1a7f283f8ef65cea31f4436a95"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
117
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaacc3ee1a7f283f8ef65cea31f4436a95">MAX</a>(x, y)   ((x) > (y) ? (x) : (y))</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
118
|
<tr class="memdesc:gaacc3ee1a7f283f8ef65cea31f4436a95"><td class="mdescLeft"> </td><td class="mdescRight">Computes the maximum of <em>x</em> and <em>y</em>. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
119
|
<tr class="separator:gaacc3ee1a7f283f8ef65cea31f4436a95"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
120
|
<tr class="memitem:ga346c951fa5af23cdbf1d18a59b2babd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga346c951fa5af23cdbf1d18a59b2babd1"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
121
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga346c951fa5af23cdbf1d18a59b2babd1">ALIGN_n</a>(x, n)   ((((uint32_t)x) + ((n)-1)) & ~((n)-1))</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
122
|
<tr class="memdesc:ga346c951fa5af23cdbf1d18a59b2babd1"><td class="mdescLeft"> </td><td class="mdescRight">Align <em>x</em> to <em>n</em> bytes (<em>n</em> must be power of 2) <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
123
|
<tr class="separator:ga346c951fa5af23cdbf1d18a59b2babd1"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
124
|
<tr class="memitem:gad7bc04eee187f219f2544905267568b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad7bc04eee187f219f2544905267568b0"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
125
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gad7bc04eee187f219f2544905267568b0">ALIGN_8</a>(x)   <a class="el" href="group__api__core__macro.html#ga346c951fa5af23cdbf1d18a59b2babd1">ALIGN_n</a>(x, 8)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
126
|
<tr class="memdesc:gad7bc04eee187f219f2544905267568b0"><td class="mdescLeft"> </td><td class="mdescRight">Align <em>x</em> to 8 bytes. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
127
|
<tr class="separator:gad7bc04eee187f219f2544905267568b0"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
128
|
<tr class="memitem:ga8d334bd237af6b4e1eb929ef32b33ab0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8d334bd237af6b4e1eb929ef32b33ab0"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
129
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga8d334bd237af6b4e1eb929ef32b33ab0">ALIGN_4</a>(x)   <a class="el" href="group__api__core__macro.html#ga346c951fa5af23cdbf1d18a59b2babd1">ALIGN_n</a>(x, 4)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
130
|
<tr class="memdesc:ga8d334bd237af6b4e1eb929ef32b33ab0"><td class="mdescLeft"> </td><td class="mdescRight">Align <em>x</em> to 4 bytes. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
131
|
<tr class="separator:ga8d334bd237af6b4e1eb929ef32b33ab0"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
132
|
<tr class="memitem:ga77baa56c8d3584b953f0a2626e6844ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga77baa56c8d3584b953f0a2626e6844ad"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
133
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga77baa56c8d3584b953f0a2626e6844ad">ARRAY_COUNT</a>(x)   (sizeof (x) / sizeof *(x))</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
134
|
<tr class="memdesc:ga77baa56c8d3584b953f0a2626e6844ad"><td class="mdescLeft"> </td><td class="mdescRight">Return number of elements in static array <em>x</em>. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
135
|
<tr class="separator:ga77baa56c8d3584b953f0a2626e6844ad"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
136
|
<tr class="memitem:gab27aa3ef76302b5221766abfd4f47e64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab27aa3ef76302b5221766abfd4f47e64"></a>
|
| dan_ackme |
13:2b51f5267c92
|
137
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a>(result, func)   ((int)(result = (func)) < (int)<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a>)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
138
|
<tr class="memdesc:gab27aa3ef76302b5221766abfd4f47e64"><td class="mdescLeft"> </td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value contains error. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
139
|
<tr class="separator:gab27aa3ef76302b5221766abfd4f47e64"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
140
|
<tr class="memitem:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabb158b483cd6d8a8d2d4bf8d38bc9830"></a>
|
| dan_ackme |
13:2b51f5267c92
|
141
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gabb158b483cd6d8a8d2d4bf8d38bc9830">WICONNECT_SUCCEEDED</a>(result, func)   ((result = (func)) == <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a>)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
142
|
<tr class="memdesc:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="mdescLeft"> </td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value is WICONNECT_SUCCESS. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
143
|
<tr class="separator:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
144
|
<tr class="memitem:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2aa16118029ab13ab41514cb8eb93ba7"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
145
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga2aa16118029ab13ab41514cb8eb93ba7">WICONNECT_MAX_CMD_SIZE</a>   128</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
146
|
<tr class="memdesc:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="mdescLeft"> </td><td class="mdescRight">The maximum command size that may be sent to the WiConnect WiFi module. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
147
|
<tr class="separator:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
148
|
<tr class="memitem:ga1525d7c98c2da34fc1a64de49253abdb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1525d7c98c2da34fc1a64de49253abdb"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
149
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga1525d7c98c2da34fc1a64de49253abdb">WICONNECT_MAX_VERSION_SIZE</a>   96</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
150
|
<tr class="memdesc:ga1525d7c98c2da34fc1a64de49253abdb"><td class="mdescLeft"> </td><td class="mdescRight">The maximum WiConnect WiFi module version string size. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
151
|
<tr class="separator:ga1525d7c98c2da34fc1a64de49253abdb"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
152
|
<tr class="memitem:ga45fe565132845ca570ded816f25561b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga45fe565132845ca570ded816f25561b0"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
153
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga45fe565132845ca570ded816f25561b0">WICONNECT_MAX_SOCKETS</a>   8</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
154
|
<tr class="memdesc:ga45fe565132845ca570ded816f25561b0"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of simulanteous opened sockets. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
155
|
<tr class="separator:ga45fe565132845ca570ded816f25561b0"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
156
|
<tr class="memitem:ga7c5dcedd35669199b46bb292b3d3b525"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7c5dcedd35669199b46bb292b3d3b525"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
157
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga7c5dcedd35669199b46bb292b3d3b525">WICONNECT_MAX_HOST_SIZE</a>   64</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
158
|
<tr class="memdesc:ga7c5dcedd35669199b46bb292b3d3b525"><td class="mdescLeft"> </td><td class="mdescRight">The maximum server string length. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
159
|
<tr class="separator:ga7c5dcedd35669199b46bb292b3d3b525"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
160
|
<tr class="memitem:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
161
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga8bc3b8d2e7e7c9d10b23e0a15cd4507a">WICONNECT_MAX_FILENAME_SIZE</a>   96</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
162
|
<tr class="memdesc:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="mdescLeft"> </td><td class="mdescRight">The maximum Wiconnect Module flash filesystem filename length. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
163
|
<tr class="separator:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
21:17bb3eddcbae
|
164
|
<tr class="memitem:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga580e5f45fee866c845e0d3fd1eb1744a"></a>
|
| dan_ackme |
21:17bb3eddcbae
|
165
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>   0xFFFFFFFF</td></tr>
|
| dan_ackme |
21:17bb3eddcbae
|
166
|
<tr class="memdesc:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="mdescLeft"> </td><td class="mdescRight">Never timeout. <br /></td></tr>
|
| dan_ackme |
21:17bb3eddcbae
|
167
|
<tr class="separator:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
21:17bb3eddcbae
|
168
|
<tr class="memitem:ga12620767dcf50182fb9f72fe5d995301"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga12620767dcf50182fb9f72fe5d995301"></a>
|
| dan_ackme |
21:17bb3eddcbae
|
169
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga12620767dcf50182fb9f72fe5d995301">WICONNECT_NO_WAIT</a>   0</td></tr>
|
| dan_ackme |
21:17bb3eddcbae
|
170
|
<tr class="memdesc:ga12620767dcf50182fb9f72fe5d995301"><td class="mdescLeft"> </td><td class="mdescRight">Timeout immediately. <br /></td></tr>
|
| dan_ackme |
21:17bb3eddcbae
|
171
|
<tr class="separator:ga12620767dcf50182fb9f72fe5d995301"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
172
|
<tr class="memitem:gad466ede4f07512308e38402d777d8380"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad466ede4f07512308e38402d777d8380"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
173
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gad466ede4f07512308e38402d777d8380">WICONNECT_ASYNC_TIMER_ENABLED</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
174
|
<tr class="memdesc:gad466ede4f07512308e38402d777d8380"><td class="mdescLeft"> </td><td class="mdescRight">When defined enables asynchronous command processing. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
175
|
<tr class="separator:gad466ede4f07512308e38402d777d8380"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
176
|
<tr class="memitem:gae9cf1249b46e784aa05250e2bcbe2e02"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9cf1249b46e784aa05250e2bcbe2e02"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
177
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gae9cf1249b46e784aa05250e2bcbe2e02">WICONNECT_ENABLE_MALLOC</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
178
|
<tr class="memdesc:gae9cf1249b46e784aa05250e2bcbe2e02"><td class="mdescLeft"> </td><td class="mdescRight">When defined enables user supplied dynamic memory allocation. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
179
|
<tr class="separator:gae9cf1249b46e784aa05250e2bcbe2e02"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
180
|
<tr class="memitem:ga53fde64c3e7647a192281a015cd02f48"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga53fde64c3e7647a192281a015cd02f48"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
181
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga53fde64c3e7647a192281a015cd02f48">WICONNECT_SERIAL_RX_BUFFER</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
182
|
<tr class="memdesc:ga53fde64c3e7647a192281a015cd02f48"><td class="mdescLeft"> </td><td class="mdescRight">When defined enables Host<->Wiconnect Module serial RX buffering. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
183
|
<tr class="separator:ga53fde64c3e7647a192281a015cd02f48"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
184
|
<tr class="memitem:gae7b6cfdff3a9aef465d5c4434937417d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae7b6cfdff3a9aef465d5c4434937417d"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
185
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gae7b6cfdff3a9aef465d5c4434937417d">WICONNECT_USE_DEFAULT_STRING_BUFFERS</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
186
|
<tr class="memdesc:gae7b6cfdff3a9aef465d5c4434937417d"><td class="mdescLeft"> </td><td class="mdescRight">When defined enables certain conversion API functions to use a default buffer to store string. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
187
|
<tr class="separator:gae7b6cfdff3a9aef465d5c4434937417d"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
188
|
<tr class="memitem:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaff0108d684631b2bb88e1f6c255e9ac"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
189
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaaff0108d684631b2bb88e1f6c255e9ac">WICONNECT_DEFAULT_MALLOC</a>   malloc</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
190
|
<tr class="memdesc:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="mdescLeft"> </td><td class="mdescRight">When WICONNECT_ENABLE_MALLOC defined, this is the default malloc function. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
191
|
<tr class="separator:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
192
|
<tr class="memitem:ga0a14e4bc7a0aed9311b552c0ee8fd7ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0a14e4bc7a0aed9311b552c0ee8fd7ef"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
193
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga0a14e4bc7a0aed9311b552c0ee8fd7ef">WICONNECT_DEFAULT_FREE</a>   free</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
194
|
<tr class="memdesc:ga0a14e4bc7a0aed9311b552c0ee8fd7ef"><td class="mdescLeft"> </td><td class="mdescRight">When WICONNECT_ENABLE_MALLOC defined, this is the default free function. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
195
|
<tr class="separator:ga0a14e4bc7a0aed9311b552c0ee8fd7ef"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
196
|
<tr class="memitem:ga2e7ffaac225bc56852bb504f531aafa0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2e7ffaac225bc56852bb504f531aafa0"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
197
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga2e7ffaac225bc56852bb504f531aafa0">WICONNECT_DEFAULT_BAUD</a>   115200</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
198
|
<tr class="memdesc:ga2e7ffaac225bc56852bb504f531aafa0"><td class="mdescLeft"> </td><td class="mdescRight">The default Host<->Wiconnect Module serial BAUD rate. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
199
|
<tr class="separator:ga2e7ffaac225bc56852bb504f531aafa0"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
200
|
<tr class="memitem:ga7741b7a0fbbf9b7e47898b7d30e5e321"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7741b7a0fbbf9b7e47898b7d30e5e321"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
201
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga7741b7a0fbbf9b7e47898b7d30e5e321">WICONNECT_DEFAULT_TIMEOUT</a>   3000</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
202
|
<tr class="memdesc:ga7741b7a0fbbf9b7e47898b7d30e5e321"><td class="mdescLeft"> </td><td class="mdescRight">The default command timeout (i.e max command executing time) <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
203
|
<tr class="separator:ga7741b7a0fbbf9b7e47898b7d30e5e321"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
204
|
<tr class="memitem:ga7352d6662e438d0969593df9e657d43f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7352d6662e438d0969593df9e657d43f"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
205
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>   8</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
206
|
<tr class="memdesc:ga7352d6662e438d0969593df9e657d43f"><td class="mdescLeft"> </td><td class="mdescRight">When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the max number of asynchronous commands that may be queued. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
207
|
<tr class="separator:ga7352d6662e438d0969593df9e657d43f"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
208
|
<tr class="memitem:ga9e7032540d999edf0dbae31e51c85962"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e7032540d999edf0dbae31e51c85962"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
209
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga9e7032540d999edf0dbae31e51c85962">WICONNECT_DEFAULT_COMMAND_PROCESSING_PERIOD</a>   50</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
210
|
<tr class="memdesc:ga9e7032540d999edf0dbae31e51c85962"><td class="mdescLeft"> </td><td class="mdescRight">When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the period in milliseconds commands should be processed. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
211
|
<tr class="separator:ga9e7032540d999edf0dbae31e51c85962"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
212
|
<tr class="memitem:ga347d0e1228e8174563c6bcf48de18401"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga347d0e1228e8174563c6bcf48de18401"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
213
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a>   false</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
214
|
<tr class="memdesc:ga347d0e1228e8174563c6bcf48de18401"><td class="mdescLeft"> </td><td class="mdescRight">The default blocking mode of the Library. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
215
|
<tr class="separator:ga347d0e1228e8174563c6bcf48de18401"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
216
|
<tr class="memitem:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa1dbeca66111f3a22d0ee6b122d69270"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
217
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>   NC</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
218
|
<tr class="memdesc:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="mdescLeft"> </td><td class="mdescRight">Default value for a pin, Not connected. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
219
|
<tr class="separator:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
220
|
<tr class="memitem:ga596d1da2fb23f4e748c83d64a47e10b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga596d1da2fb23f4e748c83d64a47e10b3"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
221
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3">delayMs</a>(ms)   wait_ms(ms)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
222
|
<tr class="memdesc:ga596d1da2fb23f4e748c83d64a47e10b3"><td class="mdescLeft"> </td><td class="mdescRight">Function to stop processor for specified number of milliseconds. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
223
|
<tr class="separator:ga596d1da2fb23f4e748c83d64a47e10b3"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
224
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
225
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
| dan_ackme |
13:2b51f5267c92
|
226
|
<p>Core macros. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
227
|
</div><!-- contents -->
|
| dan_ackme |
11:ea484e1b7fc4
|
228
|
</div><!-- doc-content -->
|
| dan_ackme |
11:ea484e1b7fc4
|
229
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
| dan_ackme |
11:ea484e1b7fc4
|
230
|
<ul>
|
| dan_ackme |
13:2b51f5267c92
|
231
|
<li class="footer">© ACKme Networks 2014</li>
|
| dan_ackme |
11:ea484e1b7fc4
|
232
|
</ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
233
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
234
|
</body>
|
| dan_ackme |
13:2b51f5267c92
|
235
|
</html> |
ACKme
AMW006-A02