WifiConfig_GetStoredNetworks 函数

标头: #include <applibs/wificonfig.h>

检索设备上存储的所有 Wi-Fi 网络。 此函数不是线程安全的。

注意

在调用 WifiConfig_GetStoredNetworks 之前,必须调用 WifiConfig_GetStoredNetworkCount 并将结果用作作为 参数传入storedNetworkArray的 WifiConfig_StoredNetwork 数组的数组大小。

  • 如果 storedNetworkArray 太小而无法容纳所有存储 Wi-Fi 网络,则此函数将填充数组并返回数组元素的数目。

  • 如果 WiFiConfig 功能不存在,则函数将返回一个空数组。

ssize_t WifiConfig_GetStoredNetworks(WifiConfig_StoredNetwork * storedNetworkArray, size_t storedNetworkArrayCount);

参数

  • storedNetworkArray 指向返回存储 Wi-Fi 网络的数组的指针。

  • storedNetworkArrayCount 可以容纳的元素 storedNetworkArray 数。 对于每个存储 Wi-Fi 网络,数组应有一个元素。

错误

如果遇到错误并设置为 errno 错误值,则返回 -1。

  • EACCES:应用程序清单不包括 WifiConfig 功能。

  • EFAULT: storedNetworkArray 参数为 NULL。

  • ERANGE: storedNetworkArrayCount 参数为 0。

  • EINVAL: storedNetworkArray 参数或其结构版本无效。

  • EAGAIN:Wi-Fi 设备尚未准备就绪。

还可以指定任何其他 errno 错误;此类错误不是确定性的,并且可能不会通过系统更新保留相同的行为。

返回值

返回 WifiConfig_StoredNetwork 数组中的元素数,如果失败,则返回 -1,在这种情况下 errno ,将 设置为错误值。

应用程序清单要求

应用程序清单必须包含 WifiConfig 功能。