esp_wifi_scan_get_ap_records() function

Get AP list found in last scan. @attention This API will free all memory occupied by scanned AP list.

Syntax

Show:

Summary

Declaration

from esp_wifi.h:601

esp_err_t esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_records);

Arguments

Argument

Description

number

As input param, it stores max AP number ap_records can hold. As output param, it receives the actual AP number this API returns.

ap_records

wifi_ap_record_t array to hold the found APs

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start - ESP_ERR_INVALID_ARG: invalid argument - ESP_ERR_NO_MEM: out of memory

Examples

esp_wifi_scan_get_ap_records() is referenced by 5 libraries and example projects:

References

from examples

esp_wifi_scan_get_ap_records() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle