RDK Documentation (Open Sourced RDK Components)
Device Settings MFR WIFI Public API.

Description

Functions

WIFI_API_RESULT WIFI_Init (void)
 Initialize the underlying WIFI data sub-system. More...
 
WIFI_API_RESULT WIFI_DeInit (void)
 Terminate the the WIFI data sub-system. More...
 
WIFI_API_RESULT WIFI_GetCredentials (WIFI_DATA *pData)
 
WIFI_API_RESULT WIFI_SetCredentials (WIFI_DATA *pData)
 
WIFI_API_RESULT WIFI_EraseAllData (void)
 

Function Documentation

◆ WIFI_Init()

WIFI_API_RESULT WIFI_Init ( void  )

Initialize the underlying WIFI data sub-system.

This function must initialize the WIFI data module and any associated data structures.

Parameters
None
Returns
Error Code.
Return values
::WIFI_API_RESULT

◆ WIFI_DeInit()

WIFI_API_RESULT WIFI_DeInit ( void  )

Terminate the the WIFI data sub-system.

This function resets any data structures used within the platform wifi module, and releases the wifi specific device handles.

Parameters
None
Returns
Error Code.
Return values
::WIFI_API_RESULT

◆ WIFI_GetCredentials()

WIFI_API_RESULT WIFI_GetCredentials ( WIFI_DATA pData)
Parameters
None
Returns
Error Code.
Return values
::WIFI_API_RESULT

◆ WIFI_SetCredentials()

WIFI_API_RESULT WIFI_SetCredentials ( WIFI_DATA pData)
Parameters
None
Returns
Error Code.
Return values
::WIFI_API_RESULT

◆ WIFI_EraseAllData()

WIFI_API_RESULT WIFI_EraseAllData ( void  )
Parameters
None
Returns
Error Code.
Return values
::WIFI_API_RESULT