The Connection Information API provides functions for managing the network information.

Required Header

#include <wifi-manager.h>

Overview

The Connection Information API provides functions for managing the network information. You can manage the network information using the functions.

Related Features

This API is related with the following features:

http://tizen.org/feature/network.wifi

It is recommended to design applications with regard to features, for reliability.

You can check if a device supports the related features for this API by using System Information, and control your application's actions accordingly.

To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.

More details on featuring your application can be found from Feature Element.

Functions
int	wifi_manager_ap_get_essid (wifi_manager_ap_h ap, char **essid)
	Gets ESSID (Extended Service Set Identifier).
int	wifi_manager_ap_get_raw_ssid (wifi_manager_ap_h ap, char *ssid, int ssid_len)
	Gets raw SSID (Service Set Identifier).
int	wifi_manager_ap_get_bssid (wifi_manager_ap_h ap, char **bssid)
	Gets BSSID (Basic Service Set Identifier).
int	wifi_manager_ap_get_rssi (wifi_manager_ap_h ap, int *rssi)
	Gets the RSSI.
int	wifi_manager_ap_get_rssi_level (wifi_manager_ap_h ap, wifi_manager_rssi_level_e *rssi_level)
	Gets the RSSI level.
int	wifi_manager_ap_get_frequency (wifi_manager_ap_h ap, int *frequency)
	Gets the frequency band (MHz).
int	wifi_manager_ap_get_max_speed (wifi_manager_ap_h ap, int *max_speed)
	Gets the max speed (Mbps).
int	wifi_manager_ap_is_favorite (wifi_manager_ap_h ap, bool *favorite)
	Checks whether the access point is favorite or not.
int	wifi_manager_ap_is_passpoint (wifi_manager_ap_h ap, bool *passpoint)
	Checks whether the access point is passpoint or not.
int	wifi_manager_ap_is_hidden (wifi_manager_ap_h ap, bool *is_hidden)
	Checks whether the access point is hidden or not.
int	wifi_manager_ap_get_connection_state (wifi_manager_ap_h ap, wifi_manager_connection_state_e *state)
	Gets the connection state.
int	wifi_manager_ap_get_ip_config_type (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, wifi_manager_ip_config_type_e *type)
	Gets the config type of IP.
int	wifi_manager_ap_set_ip_config_type (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, wifi_manager_ip_config_type_e type)
	Sets the config type of IP.
int	wifi_manager_ap_get_ip_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **ip_address)
	Gets the IP address.
int	wifi_manager_ap_set_ip_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *ip_address)
	Sets the IP address.
int	wifi_manager_ap_foreach_ipv6_address (wifi_manager_ap_h ap, wifi_manager_ap_ipv6_address_cb callback, void *user_data)
	Gets all IPv6 addresses assigned to the Wi-Fi interface.
int	wifi_manager_ap_get_subnet_mask (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **subnet_mask)
	Gets the subnet mask.
int	wifi_manager_ap_set_subnet_mask (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *subnet_mask)
	Sets the subnet mask.
int	wifi_manager_ap_get_gateway_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **gateway_address)
	Gets the gateway address.
int	wifi_manager_ap_set_gateway_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *gateway_address)
	Sets the gateway address.
int	wifi_manager_ap_get_dhcp_server_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **dhcp_server)
	Gets the DHCP Server address.
int	wifi_manager_ap_get_dhcp_lease_duration (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, int *dhcp_lease_duration)
	Gets the DHCP lease duration.
int	wifi_manager_ap_get_proxy_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, char **proxy_address)
	Gets the proxy address.
int	wifi_manager_ap_set_proxy_address (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, const char *proxy_address)
	Sets the proxy address.
int	wifi_manager_ap_get_proxy_type (wifi_manager_ap_h ap, wifi_manager_proxy_type_e *proxy_type)
	Gets the Proxy type.
int	wifi_manager_ap_set_proxy_type (wifi_manager_ap_h ap, wifi_manager_proxy_type_e proxy_type)
	Sets the Proxy address.
int	wifi_manager_ap_get_dns_address (wifi_manager_ap_h ap, int order, wifi_manager_address_family_e address_family, char **dns_address)
	Gets the DNS address.
int	wifi_manager_ap_set_dns_address (wifi_manager_ap_h ap, int order, wifi_manager_address_family_e address_family, const char *dns_address)
	Sets the DNS address.
int	wifi_manager_ap_get_dns_config_type (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, wifi_manager_dns_config_type_e *type)
	Gets the DNS config type.
int	wifi_manager_ap_set_dns_config_type (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, wifi_manager_dns_config_type_e type)
	Sets the DNS config type.
int	wifi_manager_ap_get_prefix_length (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, int *prefix_len)
	Gets the network prefix length.
int	wifi_manager_ap_set_prefix_length (wifi_manager_ap_h ap, wifi_manager_address_family_e address_family, int prefix_len)
	Sets the network prefix length.
int	wifi_manager_ap_get_disconnect_reason (wifi_manager_ap_h ap, wifi_manager_disconnect_reason_e *disconnect_reason)
	Gets the Wi-Fi disconnect reason from the supplicant.
int	wifi_manager_ap_get_error_state (wifi_manager_ap_h ap, wifi_manager_error_e *error_state)
	Gets the error state.
int	wifi_manager_ap_get_assoc_status_code (wifi_manager_ap_h ap, wifi_manager_assoc_status_code_e *status_code)
	Gets the Wi-Fi Association Status Code from the supplicant.
int	wifi_manager_ap_foreach_vsie (wifi_manager_ap_h ap, wifi_manager_ap_vsie_cb callback, void *user_data)
	Gets all VSIE of AP.
int	wifi_manager_ap_get_countrycode (wifi_manager_ap_h ap, char **country_code)
	Gets the raw country code.
int	wifi_manager_foreach_found_bssid (wifi_manager_ap_h ap, wifi_manager_found_bssid_cb callback, void *user_data)
	Gets the BSSID list.
Typedefs
typedef bool(*	wifi_manager_ap_ipv6_address_cb )(char ipv6_address, void user_data)
	Called with an IPv6 address.
typedef bool(*	wifi_manager_ap_vsie_cb )(unsigned char vsie, int length, void user_data)
	Called with VSIE data and length of VSIE.
typedef bool(*	wifi_manager_found_bssid_cb )(const char bssid, int rssi, int freq, void user_data)
	Called for each found BSSID.

Typedef Documentation

typedef bool(* wifi_manager_ap_ipv6_address_cb)(char *ipv6_address, void *user_data)

Called with an IPv6 address.

Since :: 4.0

Remarks:: If ipv6_address is needed outside the callback, a copy should be made. ipv6_address will be freed automatically after the execution of this callback.

Parameters:

[in]	ipv6_address	The IPv6 address
[in]	user_data	The user data passed from the foreach function

Returns:: true to continue with the next iteration of the loop,
false to break out of the loop

Precondition:: wifi_manager_ap_foreach_ipv6_address() will invoke this callback.

See also:: wifi_manager_ap_foreach_ipv6_address()

typedef bool(* wifi_manager_ap_vsie_cb)(unsigned char *vsie, int length, void *user_data)

Called with VSIE data and length of VSIE.

Since :: 5.0

Remarks:: If vsie is needed outside the callback, a copy should be made. vsie will be freed automatically after the execution of this callback.

Parameters:

[in]	vsie	The vendor specific data
[in]	length	The length of vendor specific data
[in]	user_data	The user data passed from the foreach function

Returns:: true to continue with the next iteration of the loop,
false to break out of the loop

Precondition:: wifi_manager_ap_foreach_vsie() will invoke this callback.

See also:: wifi_manager_ap_foreach_vsie().

typedef bool(* wifi_manager_found_bssid_cb)(const char *bssid, int rssi, int freq, void *user_data)

Called for each found BSSID.

Since :: 5.0

Remarks:: The bssid can be used only in the callback. To use it outside, make a copy. bssid is managed by the platform and will be released after the execution of this callback.

Parameters:

[in]	bssid	The BSSID
[in]	rssi	The RSSI
[in]	freq	The frequency
[in]	user_data	The user data passed from the foreach function

Returns:: true to continue with the next iteration of the loop, otherwise false to break out of the loop

Precondition:: wifi_manager_foreach_found_bssid() will invoke this callback.

Enumeration Type Documentation

enum wifi_manager_address_family_e

Enumeration for the address type.

Since :: 3.0

Enumerator:

WIFI_MANAGER_ADDRESS_FAMILY_IPV4	IPV4 Address family
WIFI_MANAGER_ADDRESS_FAMILY_IPV6	IPV6 Address family

enum wifi_manager_dns_config_type_e

Enumeration for DNS Configuration type.

Since :: 4.0

Enumerator:

WIFI_MANAGER_DNS_CONFIG_TYPE_NONE	Not defined
WIFI_MANAGER_DNS_CONFIG_TYPE_STATIC	Manual DNS configuration
WIFI_MANAGER_DNS_CONFIG_TYPE_DYNAMIC	Config DNS using DHCP client

enum wifi_manager_ip_config_type_e

Enumeration for the Net IP configuration type.

Since :: 3.0

Enumerator:

WIFI_MANAGER_IP_CONFIG_TYPE_NONE	Not defined
WIFI_MANAGER_IP_CONFIG_TYPE_STATIC	Manual IP configuration
WIFI_MANAGER_IP_CONFIG_TYPE_DYNAMIC	Config IP using DHCP client (IPv4 Only)
WIFI_MANAGER_IP_CONFIG_TYPE_AUTO	Config IP from Auto IP pool (169.254/16). Later with DHCP client, if available
WIFI_MANAGER_IP_CONFIG_TYPE_FIXED	Indicates an IP address that can not be modified (IPv4 Only)

enum wifi_manager_proxy_type_e

Enumeration for the proxy method type.

Since :: 3.0

Enumerator:

WIFI_MANAGER_PROXY_TYPE_DIRECT	Direct connection
WIFI_MANAGER_PROXY_TYPE_AUTO	Auto configuration(Use PAC file). If URL property is not set, DHCP/WPAD auto-discover will be tried
WIFI_MANAGER_PROXY_TYPE_MANUAL	Manual configuration

Function Documentation

int wifi_manager_ap_foreach_ipv6_address	(	wifi_manager_ap_h	ap,
		wifi_manager_ap_ipv6_address_cb	callback,
		void *	user_data
	)

Gets all IPv6 addresses assigned to the Wi-Fi interface.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[in]	callback	The callback to be called for each IPv6 address
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value.

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_foreach_vsie	(	wifi_manager_ap_h	ap,
		wifi_manager_ap_vsie_cb	callback,
		void *	user_data
	)

Gets all VSIE of AP.

Since :: 5.0

Parameters:

[in]	ap	The access point handle
[in]	callback	The callback to be called for each VSIE of AP
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value.

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_assoc_status_code	(	wifi_manager_ap_h	ap,
		wifi_manager_assoc_status_code_e *	status_code
	)

Gets the Wi-Fi Association Status Code from the supplicant.

Since :: 5.0

Parameters:

[in]	ap	The access point handle
[out]	status_code	The supplicant Wi-Fi association status code

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_OPERATION	Invalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_bssid	(	wifi_manager_ap_h	ap,
		char **	bssid
	)

Gets BSSID (Basic Service Set Identifier).

Since :: 3.0

Remarks:: You must release bssid using free().

Parameters:

[in]	ap	The access point handle
[out]	bssid	The BSSID

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_connection_state	(	wifi_manager_ap_h	ap,
		wifi_manager_connection_state_e *	state
	)

Gets the connection state.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	state	The connection state

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_countrycode	(	wifi_manager_ap_h	ap,
		char **	country_code
	)

Gets the raw country code.

Since :: 5.0

Remarks:: You must release country_code using free().

Parameters:

[in]	ap	The access point handle
[out]	country_code	The country code, NULL if M/W does not have the country code

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_dhcp_lease_duration	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		int *	dhcp_lease_duration
	)

Gets the DHCP lease duration.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	dhcp_lease_duration	The DHCP lease duration in seconds

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_dhcp_server_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		char **	dhcp_server
	)

Gets the DHCP Server address.

Since :: 4.0

Remarks:: You must release dhcp_server using g_free(). This function is supported only for IPv4 address family.

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	dhcp_server	The DHCP server address

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_disconnect_reason	(	wifi_manager_ap_h	ap,
		wifi_manager_disconnect_reason_e *	disconnect_reason
	)

Gets the Wi-Fi disconnect reason from the supplicant.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	disconnect_reason	The supplicant disconnect reason

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_dns_address	(	wifi_manager_ap_h	ap,
		int	order,
		wifi_manager_address_family_e	address_family,
		char **	dns_address
	)

Gets the DNS address.

Since :: 3.0

Remarks:: The allowance of DNS address is 2.You must release dns_address using free().

Parameters:

[in]	ap	The access point handle
[in]	order	The order of DNS address; it starts from 1, which means first DNS address
[in]	address_family	The address family
[out]	dns_address	The DNS address

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_dns_config_type	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		wifi_manager_dns_config_type_e *	type
	)

Gets the DNS config type.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	type	The DNS config type

Returns:: 0 on success, otherwise negative error value.

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_error_state	(	wifi_manager_ap_h	ap,
		wifi_manager_error_e *	error_state
	)

Gets the error state.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[out]	error_state	The Wi-Fi connection error state

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_OPERATION	Invalid operation
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_essid	(	wifi_manager_ap_h	ap,
		char **	essid
	)

Gets ESSID (Extended Service Set Identifier).

Since :: 3.0

Remarks:: You must release essid using free().

Parameters:

[in]	ap	The access point handle
[out]	essid	The ESSID

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_frequency	(	wifi_manager_ap_h	ap,
		int *	frequency
	)

Gets the frequency band (MHz).

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	frequency	The frequency

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_gateway_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		char **	gateway_address
	)

Gets the gateway address.

Since :: 3.0

Remarks:: You must release gateway_address using free().

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	gateway_address	The gateway address

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_ip_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		char **	ip_address
	)

Gets the IP address.

Since :: 3.0

Remarks:: You must release ip_address using free().

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	ip_address	The IP address; this value is for default address e.g, IPv6 can have multiple addresses. but you can only obtain a representative address if you want to get all IPv6 address, you can use the wifi_manager_ap_foreach_ipv6_address().

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_ap_foreach_ipv6_address()

int wifi_manager_ap_get_ip_config_type	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		wifi_manager_ip_config_type_e *	type
	)

Gets the config type of IP.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	type	The type of IP config

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_max_speed	(	wifi_manager_ap_h	ap,
		int *	max_speed
	)

Gets the max speed (Mbps).

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	max_speed	The max speed

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_prefix_length	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		int *	prefix_len
	)

Gets the network prefix length.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	prefix_len	The network prefix length. In case of IPv4, it means netmask length (also called a prefix, e.g. 8, 16, 24, 32)

Returns:: 0 on success, otherwise negative error value.

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_proxy_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		char **	proxy_address
	)

Gets the proxy address.

Since :: 3.0

Remarks:: You must release proxy_address using free().

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	proxy_address	The proxy address

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_proxy_type	(	wifi_manager_ap_h	ap,
		wifi_manager_proxy_type_e *	proxy_type
	)

Gets the Proxy type.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	proxy_type	The type of proxy

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_raw_ssid	(	wifi_manager_ap_h	ap,
		char **	ssid,
		int *	ssid_len
	)

Gets raw SSID (Service Set Identifier).

Since :: 4.0

Remarks:: You must release ssid using free().

Parameters:

[in]	ap	The access point handle
[out]	ssid	The raw SSID bytes
[out]	ssid_len	The raw SSID length

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_rssi	(	wifi_manager_ap_h	ap,
		int *	rssi
	)

Gets the RSSI.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	rssi	The RSSI value (in dBm)

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_rssi_level	(	wifi_manager_ap_h	ap,
		wifi_manager_rssi_level_e *	rssi_level
	)

Gets the RSSI level.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[out]	rssi_level	The RSSI level

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_get_subnet_mask	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		char **	subnet_mask
	)

Gets the subnet mask.

Since :: 3.0

Remarks:: You must release subnet_mask using free().

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[out]	subnet_mask	The subnet mask

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_is_favorite	(	wifi_manager_ap_h	ap,
		bool *	favorite
	)

Checks whether the access point is favorite or not.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	favorite	`true` if access point is favorite, otherwise `false` if access point is not favorite

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_is_hidden	(	wifi_manager_ap_h	ap,
		bool *	is_hidden
	)

Checks whether the access point is hidden or not.

Since :: 5.5

Parameters:

[in]	ap	The access point handle
[out]	is_hidden	`true` if the access point is hidden, `false` if the access point is not hidden.

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_is_passpoint	(	wifi_manager_ap_h	ap,
		bool *	passpoint
	)

Checks whether the access point is passpoint or not.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[out]	passpoint	`true` if access point is passpoint, otherwise `false` if access point is not passpoint.

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

int wifi_manager_ap_set_dns_address	(	wifi_manager_ap_h	ap,
		int	order,
		wifi_manager_address_family_e	address_family,
		const char *	dns_address
	)

Sets the DNS address.

Since :: 3.0

Remarks:: The allowance of DNS address is 2

Parameters:

[in]	ap	The access point handle
[in]	order	The order of DNS address It starts from `1`, which means first DNS address.
[in]	address_family	The address family
[in]	dns_address	The DNS address If you set this value to `NULL`, then the existing value will be deleted.

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_dns_config_type	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		wifi_manager_dns_config_type_e	type
	)

Sets the DNS config type.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	type	The DNS config type

Returns:: 0 on success, otherwise negative error value.

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_gateway_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		const char *	gateway_address
	)

Sets the gateway address.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	gateway_address	The gateway address If you set this value to `NULL`, then the existing value will be deleted.

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_ip_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		const char *	ip_address
	)

Sets the IP address.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	ip_address	The IP address; if you set this value to NULL, then the existing value will be deleted

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_ip_config_type	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		wifi_manager_ip_config_type_e	type
	)

Sets the config type of IP.

If you set IP config type to WIFI_MANAGER_IP_CONFIG_TYPE_STATIC, then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	type	The type of IP config

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_prefix_length	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		int	prefix_len
	)

Sets the network prefix length.

Since :: 4.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	prefix_len	The network prefix length. In case of IPv4, it means netmask length (also called a prefix, e.g. 8, 16, 24, 32)

Returns:: 0 on success, otherwise negative error value.

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_proxy_address	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		const char *	proxy_address
	)

Sets the proxy address.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	proxy_address	The proxy address If you set this value to `NULL`, then the existing value will be deleted.

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_proxy_type	(	wifi_manager_ap_h	ap,
		wifi_manager_proxy_type_e	proxy_type
	)

Sets the Proxy address.

If you set Proxy type to WIFI_MANAGER_PROXY_TYPE_AUTO or WIFI_MANAGER_PROXY_TYPE_MANUAL, then Proxy will be restored.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	proxy_type	The type of proxy

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_ap_set_subnet_mask	(	wifi_manager_ap_h	ap,
		wifi_manager_address_family_e	address_family,
		const char *	subnet_mask
	)

Sets the subnet mask.

Since :: 3.0

Parameters:

[in]	ap	The access point handle
[in]	address_family	The address family
[in]	subnet_mask	The subnet mask; if you set this value to NULL, then the existing value will be deleted

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_MANAGER_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

See also:: wifi_manager_update_ap()

int wifi_manager_foreach_found_bssid	(	wifi_manager_ap_h	ap,
		wifi_manager_found_bssid_cb	callback,
		void *	user_data
	)

Gets the BSSID list.

Since :: 5.0

Parameters:

[in]	ap	The access point handle
[in]	callback	The callback to be called
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_MANAGER_ERROR_NONE	Successful
WIFI_MANAGER_ERROR_NOT_INITIALIZED	Not initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILED	Operation failed
WIFI_MANAGER_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_manager_found_bssid_cb().

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation