Diff: NetworkInterface.h

Revision:

26:8067e3d463d3

Parent:

21:17bb3eddcbae

--- a/NetworkInterface.h	Tue Aug 26 16:53:06 2014 -0700
+++ b/NetworkInterface.h	Thu Oct 23 15:16:06 2014 -0700
@@ -129,6 +129,8 @@
      * @param[in] password 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. "")
      * @param[in] completeHandler Optional, callback to be executed when the join sequence completes.
+     *                             The 'result' callback parameter contains the WiconnectResult of joining.
+     *                             The 'arg1' parameter is a @ref NetworkJoinResult of joining.
      * @return Result of method. See @ref WiconnectResult
      */
     WiconnectResult join(const char* ssid = NULL, const char *password = NULL, const Callback &completeHandler = Callback());
@@ -157,6 +159,18 @@
      */
     WiconnectResult getNetworkStatus(NetworkStatus *statusPtr);
 
+    /**
+     * @ingroup api_network_wlan
+     *
+     * @brief Get the result of joining the network
+     *
+     * Refer to @ref NetworkJoinResult for more info.
+     *
+     * @param[out] joinResultPtr Point to a @ref NetworkJoinResult which will hold the result of joining the network
+     * @return Result of method. See @ref WiconnectResult
+     */
+    WiconnectResult getNetworkJoinResult(NetworkJoinResult *joinResultPtr);
+
     // ------------------------------------------------------------------------
 
 
@@ -303,6 +317,13 @@
     /**
      * @ingroup conversion_util
      *
+     * @brief Convert @ref NetworkJoinResult to string
+     */
+    static const char* networkJoinResultToStr(NetworkJoinResult joinResult);
+
+    /**
+     * @ingroup conversion_util
+     *
      * @brief Convert @ref NetworkSignalStrength to string
      */
     static const char* signalStrengthToStr(NetworkSignalStrength signalStrenth);