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__network__settings.html
- Revision:
- 17:7268f365676b
- Parent:
- 13:2b51f5267c92
- Child:
- 26:8067e3d463d3
--- a/doc/html/group__api__network__settings.html Wed Aug 13 04:41:04 2014 -0700 +++ b/doc/html/group__api__network__settings.html Sat Aug 23 05:39:17 2014 -0700 @@ -132,10 +132,38 @@ WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gaba16b9918e55c08285cf5b8b50dbabea">wiconnect::NetworkInterface::getSignalStrength</a> (NetworkSignalStrength *signalStrengthPtr)</td></tr> <tr class="memdesc:gaba16b9918e55c08285cf5b8b50dbabea"><td class="mdescLeft"> </td><td class="mdescRight">Get signal strength to WiFi network. <br /></td></tr> <tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">wiconnect::NetworkInterface::getIpAddress</a> (char *buffer=NULL)</td></tr> +<tr class="memdesc:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="mdescLeft"> </td><td class="mdescRight">Return the current IP address of the module if possible, else return 0.0.0.0. <a href="#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">More...</a><br /></td></tr> +<tr class="separator:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>API getters/setters for module network settings. </p> <h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* wiconnect::NetworkInterface::getIpAddress </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>buffer</em> = <code>NULL</code></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return the current IP address of the module if possible, else return 0.0.0.0. </p> +<dl class="section note"><dt>Note</dt><dd>This method is only supported in blocking mode.</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Optional, buffer to IP address string. If omitted, the IP address string is stored in a local static buffer (this is non-reentrant!) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> <a class="anchor" id="ga65eb99f880ed739d0f3cd393e5b56eaf"></a> <div class="memitem"> <div class="memproto">