WifiConfig_ForgetNetwork 函数

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

重要

此函数已过时。 请改用 WifiConfig_ForgetNetworkById

从设备中删除 Wi-Fi 网络。 断开设备与网络的连接(如果设备当前已连接)。 此函数不是线程安全的。

int WifiConfig_ForgetNetwork(const WifiConfig_StoredNetwork * storedNetwork);

参数

  • storedNetwork 指向 描述 要删除的存储 Wi-Fi 网络的WifiConfig_StoredNetwork结构的指针。

错误

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

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

  • EFAULT: ssid 参数为 NULL。

  • ENOENT: storedNetwork 参数与任何存储的网络都不匹配。

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

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

  • ENETDOWN:Wi-Fi 网络接口不可用。

  • ENOSPC:Wi-Fi 网络太多,无法保留配置;删除一个,然后重试。

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

返回值

如果成功,则返回 0,如果失败,则返回 -1,在这种情况下 errno ,将 设置为错误值。

应用程序清单要求

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