FreeRTOS: Wi-Fi Management Library
Return to main page ↑
WIFI_NetworkGet

Get a Wi-Fi network profile.

uint16_t usIndex );

Gets the Wi-Fi network parameters at the given index from network list in non-volatile memory.

Note
The WIFINetworkProfile_t data returned must have the the SSID and Password lengths specified as the length without a null terminator.
Parameters
[out]pxNetworkProfile- pointer to return network profile parameters
[in]usIndex- Index of the network profile, must be between 0 to wificonfigMAX_NETWORK_PROFILES
Returns
eWiFiSuccess if the network profile was successfully retrieved, failure code otherwise.
See also
WIFINetworkProfile_t

Example

WIFINetworkProfile_t xNetworkProfile = {0};
uint16_t usIndex = 3; //Get profile stored at index 3.
WIFI_NetworkGet( &xNetworkProfile, usIndex );
WIFI_NetworkGet
WIFIReturnCode_t WIFI_NetworkGet(WIFINetworkProfile_t *pxNetworkProfile, uint16_t usIndex)
Get a Wi-Fi network profile.
WIFIReturnCode_t
WIFIReturnCode_t
Return code denoting API status.
Definition: iot_wifi.h:50
WIFINetworkProfile_t
Wi-Fi network parameters passed to the WIFI_NetworkAdd API.
Definition: iot_wifi.h:150