WifiConfig_SetTargetedScanEnabled 函数

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

启用或禁用针对网络的目标扫描。 默认已禁用目标扫描。

目标扫描用于连接到不广播其 SSID 或位于嘈杂环境中的访问点。

该设置立即生效,但是除非重启设备后调用 WifiConfig_PersistConfig 函数,否则该设置不会在设备重启后持久保留。

重要

目标扫描会导致设备发送可能会向其他设备显示网络 SSID 的探测请求。 仅应在受控环境或风险可接受的网络上使用此功能。

static int WifiConfig_SetTargetedScanEnabled(int networkId, bool enabled);

参数

  • networkId 要配置的网络的 ID。 使用 WifiConfig_AddNetwork 返回新创建的网络的网络 ID。 将网络 ID 传递给 WifiConfig_Set* 函数进行配置。 使用 WifiConfig_SetSSID 指定要针对扫描的 SSID。

  • enabled 若要在网络上启用目标扫描,则为 true;否则为 false

错误

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

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

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

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

  • EINVAL:networkId 参数无效。

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

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

返回值

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

应用程序清单要求

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