Functions |
int | wifi_ap_get_essid (wifi_ap_h ap, char **essid) |
| Gets ESSID (Extended Service Set Identifier).
|
int | wifi_ap_get_bssid (wifi_ap_h ap, char **bssid) |
| Gets BSSID (Basic Service Set Identifier).
|
int | wifi_ap_get_rssi (wifi_ap_h ap, int *rssi) |
| Gets the RSSI.
|
int | wifi_ap_get_frequency (wifi_ap_h ap, int *frequency) |
| Gets the frequency band (MHz).
|
int | wifi_ap_get_max_speed (wifi_ap_h ap, int *max_speed) |
| Gets the max speed (Mbps).
|
int | wifi_ap_is_favorite (wifi_ap_h ap, bool *favorite) |
| Checks whether the access point is favorite or not.
|
int | wifi_ap_is_passpoint (wifi_ap_h ap, bool *passpoint) |
| Checks whether the access point is passpoint or not.
|
int | wifi_ap_get_connection_state (wifi_ap_h ap, wifi_connection_state_e *state) |
| Gets the connection state.
|
int | wifi_ap_get_ip_config_type (wifi_ap_h ap, wifi_address_family_e address_family, wifi_ip_config_type_e *type) |
| Gets the config type of IP.
|
int | wifi_ap_set_ip_config_type (wifi_ap_h ap, wifi_address_family_e address_family, wifi_ip_config_type_e type) |
| Sets the config type of IP.
|
int | wifi_ap_get_ip_address (wifi_ap_h ap, wifi_address_family_e address_family, char **ip_address) |
| Gets the IP address.
|
int | wifi_ap_set_ip_address (wifi_ap_h ap, wifi_address_family_e address_family, const char *ip_address) |
| Sets the IP address.
|
int | wifi_ap_get_subnet_mask (wifi_ap_h ap, wifi_address_family_e address_family, char **subnet_mask) |
| Gets the subnet mask.
|
int | wifi_ap_set_subnet_mask (wifi_ap_h ap, wifi_address_family_e address_family, const char *subnet_mask) |
| Sets the subnet mask.
|
int | wifi_ap_get_gateway_address (wifi_ap_h ap, wifi_address_family_e address_family, char **gateway_address) |
| Gets the gateway address.
|
int | wifi_ap_set_gateway_address (wifi_ap_h ap, wifi_address_family_e address_family, const char *gateway_address) |
| Sets the gateway address.
|
int | wifi_ap_get_proxy_address (wifi_ap_h ap, wifi_address_family_e address_family, char **proxy_address) |
| Gets the proxy address.
|
int | wifi_ap_set_proxy_address (wifi_ap_h ap, wifi_address_family_e address_family, const char *proxy_address) |
| Sets the proxy address.
|
int | wifi_ap_get_proxy_type (wifi_ap_h ap, wifi_proxy_type_e *type) |
| Gets the Proxy type.
|
int | wifi_ap_set_proxy_type (wifi_ap_h ap, wifi_proxy_type_e proxy_type) |
| Sets the Proxy address.
|
int | wifi_ap_get_dns_address (wifi_ap_h ap, int order, wifi_address_family_e address_family, char **dns_address) |
| Gets the DNS address.
|
int | wifi_ap_set_dns_address (wifi_ap_h ap, int order, wifi_address_family_e address_family, const char *dns_address) |
| Sets the DNS address.
|
The Connection Information API provides functions for managing the network information.
Required Header
#include <wifi.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:
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
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 List.
Enumeration Type Documentation
Enumeration for the address type.
- Since :
- 2.3.1
- Enumerator:
WIFI_ADDRESS_FAMILY_IPV4 |
IPV4 Address family
|
WIFI_ADDRESS_FAMILY_IPV6 |
IPV6 Address family
|
Enumeration for the Net IP configuration type.
- Since :
- 2.3.1
- Enumerator:
WIFI_IP_CONFIG_TYPE_NONE |
Not defined
|
WIFI_IP_CONFIG_TYPE_STATIC |
Manual IP configuration
|
WIFI_IP_CONFIG_TYPE_DYNAMIC |
Config IP using DHCP client
|
WIFI_IP_CONFIG_TYPE_AUTO |
Config IP from Auto IP pool (169.254/16). Later with DHCP client, if available
|
WIFI_IP_CONFIG_TYPE_FIXED |
Indicates an IP address that can not be modified
|
Enumeration for the proxy method type.
- Since :
- 2.3.1
- Enumerator:
WIFI_PROXY_TYPE_DIRECT |
Direct connection
|
WIFI_PROXY_TYPE_AUTO |
Auto configuration(Use PAC file). If URL property is not set, DHCP/WPAD auto-discover will be tried
|
WIFI_PROXY_TYPE_MANUAL |
Manual configuration
|
Function Documentation
Gets BSSID (Basic Service Set Identifier).
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | bssid | The BSSID |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the connection state.
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | state | The connection state |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the DNS address.
- Since :
- 2.3.1
- 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:
-
Gets ESSID (Extended Service Set Identifier).
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | essid | The ESSID |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the frequency band (MHz).
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | frequency | The frequency |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the gateway address.
- Since :
- 2.3.1
- 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:
-
Gets the IP address.
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[in] | address_family | The address family |
[out] | ip_address | The IP address |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the config type of IP.
- Since :
- 2.3.1
- 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:
-
Gets the max speed (Mbps).
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | max_speed | The max speed |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the proxy address.
- Since :
- 2.3.1
- 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:
-
Gets the Proxy type.
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | type | The type of proxy |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the RSSI.
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | rssi | The RSSI |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Gets the subnet mask.
- Since :
- 2.3.1
- 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:
-
Checks whether the access point is favorite or not.
- Since :
- 2.3.1
- 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:
-
Checks whether the access point is passpoint or not.
- Since :
- 2.3.1
- Parameters:
-
[in] | ap | The access point handle |
[out] | passpoint | ture if access point is passpoint, otherwise false if access point is not passpoint. |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Sets the DNS address.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- 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:
-
Sets the gateway address.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- 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:
-
Sets the IP address.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- 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:
-
Sets the config type of IP.
If you set IP config type to WIFI_IP_CONFIG_TYPE_STATIC, then IP address, Gateway and Subnet mask will be set to the initial value "0.0.0.0".
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- 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:
-
Sets the proxy address.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- 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:
-
Sets the Proxy address.
If you set Proxy type to WIFI_PROXY_TYPE_AUTO or WIFI_PROXY_TYPE_MANUAL, then Proxy will be restored.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- Parameters:
-
[in] | ap | The access point handle |
[in] | proxy_type | The type of proxy |
- Returns:
- 0 on success, otherwise negative error value
- Return values:
-
Sets the subnet mask.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- 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:
-