Diff: doc/html/group__api__network__wlan.html

Revision:

26:8067e3d463d3

Parent:

17:7268f365676b

Child:

29:b6af04b77a56

--- a/doc/html/group__api__network__wlan.html	Tue Aug 26 16:53:06 2014 -0700
+++ b/doc/html/group__api__network__wlan.html	Thu Oct 23 15:16:06 2014 -0700
@@ -47,7 +47,7 @@
       <li><a href="modules.html"><span>Library&#160;API</span></a></li>
       <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
       <li><a href="annotated.html"><span>Classes</span></a></li>
-      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
       <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
@@ -118,10 +118,39 @@
 <tr class="memitem:ga047ba9670f60406466391cec5bdd28e5"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">wiconnect::NetworkInterface::getNetworkStatus</a> (NetworkStatus *statusPtr)</td></tr>
 <tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get connection status to WiFi network.  <a href="#ga047ba9670f60406466391cec5bdd28e5">More...</a><br /></td></tr>
 <tr class="separator:ga047ba9670f60406466391cec5bdd28e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">wiconnect::NetworkInterface::getNetworkJoinResult</a> (NetworkJoinResult *joinResultPtr)</td></tr>
+<tr class="memdesc:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result of joining the network.  <a href="#gafefe6e679d7b48a7127d3ed6371fe58b">More...</a><br /></td></tr>
+<tr class="separator:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <p>Methods for joining/leaving a WLAN. </p>
 <h2 class="groupheader">Function Documentation</h2>
+<a class="anchor" id="gafefe6e679d7b48a7127d3ed6371fe58b"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">WiconnectResult wiconnect::NetworkInterface::getNetworkJoinResult </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> *&#160;</td>
+          <td class="paramname"><em>joinResultPtr</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Get the result of joining the network. </p>
+<p>Refer to <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> for more info.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">joinResultPtr</td><td>Point to a <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> which will hold the result of joining the network </td></tr>
+  </table>
+  </dd>
+</dl>
+<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>
+
+</div>
+</div>
 <a class="anchor" id="ga047ba9670f60406466391cec5bdd28e5"></a>
 <div class="memitem">
 <div class="memproto">
@@ -190,7 +219,7 @@
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">ssid</td><td>Optional, optionally set the SSID of the network to join </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Optional, optionally set the passkey of the network to join Note: to join an OPEN network, set this parameter to a null string (i.e. "") </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">completeHandler</td><td>Optional, callback to be executed when the join sequence completes. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">completeHandler</td><td>Optional, callback to be executed when the join sequence completes. The 'result' callback parameter contains the WiconnectResult of joining. The 'arg1' parameter is a <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> of joining. </td></tr>
   </table>
   </dd>
 </dl>