Share via

WifiConfig_SetConfigName Function

  • Article

Header: #include <applibs/wificonfig.h>

Sets a name for a network configuration. The name can be used as a convenient handle to identify a network configuration. It is strongly recommended that this name be unique.

The setting is effective immediately but won't persist across device reboots unless the WifiConfig_PersistConfig function is called after this function.

static int WifiConfig_SetConfigName(int networkId, const char *configName);

Parameters

  • networkId The ID of the network to configure. WifiConfig_AddNetwork returns the network ID.

  • configname A pointer to a byte array containing the configuration name. The byte array must be NULL terminated and be less than or equal to WIFICONFIG_CONFIG_NAME_MAX_LENGTH bytes (excluding the termination).

Errors

Returns -1 if an error is encountered and sets errno to the error value.

  • EACCES: the application manifest doesn't include the WifiConfig capability.

  • EFAULT: the configName parameter is NULL.

  • ERANGE: the configName parameter is greater than WIFICONFIG_CONFIG_NAME_MAX_LENGTH.

  • EAGAIN: the Wi-Fi device isn't ready.

  • ENETDOWN: the Wi-Fi network interface is unavailable.

  • EINVAL: the networkId parameter is invalid.

  • ENODEV: the networkId parameter doesn't match any of the IDs of the stored networks.

Any other errno may also be specified; such errors aren't deterministic and the same behavior might not be retained through system updates.

Return value

Returns 0 for success, or -1 for failure, in which case errno is set to the error value.

Application manifest requirements

The application manifest must include the WifiConfig capability.