qwf_wifi_GetScanResults()

Updated: April 19, 2023

Query the available Wi-Fi access points found in the latest scan

Synopsis:

#include <qwf/qwf_wifi.h>
qwf_wifi_Results_e qwf_wifi_GetScanResults(qwf_Context_t *pCtx,
                                           uint8_t *const pNumEntries,
                                           qwf_wifi_ScanResult_t *const pResultArray)

Arguments:

pCtx
A pointer to the QWF service context
pNumEntries
On input, a pointer to memory specifying the number of scan result entries requested. On output, this memory stores the number of entries written into pResultArray. This new value represents the number of available access points and may be less than what was requested.
pResultArray
A pointer to memory for storing an array of qwf_wifi_ScanResult_t objects, which will contain the data for individual access points

Library:

qwf_interface

Description:

This function queries the Wi-Fi Manager service for the available Wi-Fi access points found in the latest scan. The function writes an array of qwf_wifi_ScanResult_t objects into the space pointed to by pResultArray; these objects store the access point data.

The client must allocate enough array memory to store the number of entries requested by pNumEntries. The function updates this variable so it contains the actual number of array entries written.

Returns:

WIFI_OK Successful result

WIFI_ERR_INACTIVE The QWF Wi-Fi Manager service is inactive or not ready

WIFI_ERR_INT The QWF Wi-Fi Manager service couldn't issue the request or read the response, or there wasn't enough memory for the requested array size

WIFI_ERR_PARAM A pointer argument is NULL, or pNumEntries initially contains 0