WifiConfig_GetNetworkIdByConfigName 函数

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

获取具有给定名称的网络配置的网络 ID。 使用 WifiConfig_SetConfigName 分配网络名称。 网络 ID 可能会随着网络配置的添加和删除而更改,因此应用应在更改存储的网络配置之前再次获取网络 ID。

int WifiConfig_GetNetworkIdByConfigName(const char *configName);

参数

  • configName 指向网络配置名称的指针。 此名称是使用 WifiConfig_SetConfigName 设置的。 字符串必须以 NULL 结尾,并且小于或等于 WIFICONFIG_CONFIG_NAME_MAX_LENGTH 字节 (不包括终止) 。

错误

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

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

  • EFAULT: configName 参数为 NULL。

  • ERANGE: configName 参数大于 WIFICONFIG_SSID_MAX_LENGTH

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

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

  • ENODEV:找不到指定的网络配置。

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

返回值

返回指定网络的网络 ID, (非负值) ,如果失败,则返回 -1,在这种情况下 errno ,将设置为错误值。 网络 ID 将传递给WifiConfig_Setxxx函数作为要配置的网络的标识符。

应用程序清单要求

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