The Wi-Fi API provides functions for managing Wi-Fi.

Required Header

#include <wifi.h>

Overview

The Wi-Fi Manager provides functions for managing Wi-Fi. Using the Wi-Fi Manager, you can implement features that allow the users of your application to:

Activate / Deactivate the Wi-Fi device
Connect to the access point
Scans the access points

Related Features

This API is related with the following features:

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

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.

Functions
int	wifi_activate (wifi_activated_cb callback, void *user_data)
	Activates Wi-Fi asynchronously.
int	wifi_activate_with_wifi_picker_tested (wifi_activated_cb callback, void *user_data)
	Activates Wi-Fi asynchronously and displays Wi-Fi picker (popup) when Wi-Fi is not automatically connected.
int	wifi_deactivate (wifi_deactivated_cb callback, void *user_data)
	Deactivates Wi-Fi asynchronously.
int	wifi_is_activated (bool *activated)
	Checks whether Wi-Fi is activated.
int	wifi_get_mac_address (char **mac_address)
	Gets the local MAC address.
int	wifi_get_network_interface_name (char **name)
	Gets the name of the network interface.
int	wifi_scan (wifi_scan_finished_cb callback, void *user_data)
	Starts scan asynchronously.
int	wifi_get_connected_ap (wifi_ap_h *ap)
	Gets the handle of the connected access point.
int	wifi_foreach_found_aps (wifi_found_ap_cb callback, void *user_data)
	Gets the result of the scan.
int	wifi_connect (wifi_ap_h ap, wifi_connected_cb callback, void *user_data)
	Connects the access point asynchronously.
int	wifi_disconnect (wifi_ap_h ap, wifi_disconnected_cb callback, void *user_data)
	Disconnects the access point asynchronously.
int	wifi_connect_by_wps_pbc (wifi_ap_h ap, wifi_connected_cb callback, void *user_data)
	Connects the access point with WPS PBC asynchronously.
int	wifi_connect_by_wps_pin (wifi_ap_h ap, const char pin, wifi_connected_cb callback, void user_data)
	Connects the access point with WPS PIN asynchronously.
int	wifi_forget_ap (wifi_ap_h ap)
	Deletes the information of stored access point and disconnects it when it connected.
Typedefs
typedef bool(*	wifi_found_ap_cb )(wifi_ap_h ap, void *user_data)
	Called when you get the found access point repeatedly.
typedef void(*	wifi_scan_finished_cb )(wifi_error_e error_code, void *user_data)
	Called when the scan is finished.
typedef void(*	wifi_activated_cb )(wifi_error_e result, void *user_data)
	Called after wifi_activate() or wifi_activate_with_wifi_picker_tested() is completed.
typedef void(*	wifi_deactivated_cb )(wifi_error_e result, void *user_data)
	Called after wifi_deactivate() is completed.
typedef void(*	wifi_connected_cb )(wifi_error_e result, void *user_data)
	Called after either wifi_connect() or wifi_connect_by_wps_pbc() or wifi_connect_by_wps_pin() are completed.
typedef void(*	wifi_disconnected_cb )(wifi_error_e result, void *user_data)
	Called after wifi_disconnect() is completed.

Typedef Documentation

typedef void(* wifi_activated_cb)(wifi_error_e result, void *user_data)

Called after wifi_activate() or wifi_activate_with_wifi_picker_tested() is completed.

Since :: 2.3.1

Parameters:

[in]	result	The result
[in]	user_data	The user data passed from wifi_activate() and wifi_activate_with_wifi_picker_tested()

Precondition:: wifi_activate() or wifi_activate_with_wifi_picker_tested() will invoke this callback function.

See also:: wifi_activate(); wifi_activate_with_wifi_picker_tested()

typedef void(* wifi_connected_cb)(wifi_error_e result, void *user_data)

Called after either wifi_connect() or wifi_connect_by_wps_pbc() or wifi_connect_by_wps_pin() are completed.

Since :: 2.3.1

Parameters:

[in]	result	The result
[in]	user_data	The user data passed from either wifi_connect() or wifi_connect_by_wps_pbc() or wifi_connect_by_wps_pin()

Precondition:: Either wifi_connect() or wifi_connect_by_wps_pbc() or wifi_connect_by_wps_pin() will invoke this callback function.

See also:: wifi_connect(); wifi_connect_by_wps_pbc(); wifi_connect_by_wps_pin()

typedef void(* wifi_deactivated_cb)(wifi_error_e result, void *user_data)

Called after wifi_deactivate() is completed.

Since :: 2.3.1

Parameters:

[in]	result	The result
[in]	user_data	The user data passed from wifi_deactivate()

Precondition:: wifi_deactivate() will invoke this callback function.

See also:: wifi_deactivate()

typedef void(* wifi_disconnected_cb)(wifi_error_e result, void *user_data)

Called after wifi_disconnect() is completed.

Since :: 2.3.1

Parameters:

[in]	result	The result
[in]	user_data	The user data passed from wifi_disconnect()

Precondition:: wifi_disconnect() will invoke this callback function.

See also:: wifi_disconnect()

typedef bool(* wifi_found_ap_cb)(wifi_ap_h ap, void *user_data)

Called when you get the found access point repeatedly.

Since :: 2.3.1

Remarks:: ap is valid only in this function. In order to use ap outside this function, you must copy the ap with wifi_ap_clone().

Parameters:

[in]	ap	The access point
[in]	user_data	The user data passed from the request function

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

Precondition:: wifi_foreach_found_aps() will invoke this callback.

See also:: wifi_foreach_found_aps()

typedef void(* wifi_scan_finished_cb)(wifi_error_e error_code, void *user_data)

Called when the scan is finished.

Since :: 2.3.1

Parameters:

[in]	error_code	The error code
[in]	user_data	The user data passed from the callback registration function

See also:: wifi_scan(); wifi_set_background_scan_cb(); wifi_unset_background_scan_cb()

Enumeration Type Documentation

enum wifi_error_e

Enumeration for the Wi-Fi error type.

Since :: 2.3.1

Enumerator:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OUT_OF_MEMORY	Out of memory error
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED	Address family not supported
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_NO_CONNECTION	There is no connected AP
WIFI_ERROR_NOW_IN_PROGRESS	Now in progress
WIFI_ERROR_ALREADY_EXISTS	Already exists
WIFI_ERROR_OPERATION_ABORTED	Operation is aborted
WIFI_ERROR_DHCP_FAILED	DHCP failed
WIFI_ERROR_INVALID_KEY	Invalid key
WIFI_ERROR_NO_REPLY	No reply
WIFI_ERROR_SECURITY_RESTRICTED	Restricted by security system policy
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not Supported

Function Documentation

int wifi_activate	(	wifi_activated_cb	callback,
		void *	user_data
	)

Activates Wi-Fi asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	callback	The callback function to be called This can be `NULL` if you don't want to get the notification.
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_SECURITY_RESTRICTED	Restricted by security system policy
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: wifi_activated_cb() will be invoked.

See also:: wifi_activated_cb(); wifi_deactivate()

int wifi_activate_with_wifi_picker_tested	(	wifi_activated_cb	callback,
		void *	user_data
	)

Activates Wi-Fi asynchronously and displays Wi-Fi picker (popup) when Wi-Fi is not automatically connected.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	callback	The callback function to be called This can be `NULL` if you don't want to get the notification.
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_SECURITY_RESTRICTED	Restricted by security system policy
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: wifi_activated_cb() will be invoked.

See also:: wifi_activated_cb(); wifi_deactivate()

int wifi_connect	(	wifi_ap_h	ap,
		wifi_connected_cb	callback,
		void *	user_data
	)

Connects the access point asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	ap	The access point handle
[in]	callback	The callback function to be called This can be `NULL` if you don't want to get the notification.
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_connected_cb().

See also:: wifi_connected_cb(); wifi_connect_by_wps_pbc(); wifi_connect_by_wps_pin(); wifi_disconnect()

int wifi_connect_by_wps_pbc	(	wifi_ap_h	ap,
		wifi_connected_cb	callback,
		void *	user_data
	)

Connects the access point with WPS PBC asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	ap	The access point handle
[in]	callback	The callback function to be called This can be NULL if you don't want to get the notification.
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_connected_cb().

See also:: wifi_connected_cb(); wifi_connect(); wifi_disconnect(); wifi_ap_is_wps_supported()

int wifi_connect_by_wps_pin	(	wifi_ap_h	ap,
		const char *	pin,
		wifi_connected_cb	callback,
		void *	user_data
	)

Connects the access point with WPS PIN asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	ap	The access point handle
[in]	pin	The WPS PIN is a non-NULL string with length greater than 0 and less than or equal to 8
[in]	callback	The callback function to be called (this can be NULL if you don't want to get the notification)
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_connected_cb().

See also:: wifi_connected_cb(); wifi_connect(); wifi_disconnect(); wifi_ap_is_wps_supported()

int wifi_deactivate	(	wifi_deactivated_cb	callback,
		void *	user_data
	)

Deactivates Wi-Fi asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	callback	The callback function to be called This can be `NULL` if you don't want to get the notification.
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: wifi_deactivated_cb() will be invoked.

See also:: wifi_deactivated_cb(); wifi_activate()

int wifi_disconnect	(	wifi_ap_h	ap,
		wifi_disconnected_cb	callback,
		void *	user_data
	)

Disconnects the access point asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	ap	The access point handle
[in]	callback	The callback function to be called This can be `NULL` if you don't want to get the notification.
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_disconnected_cb().

See also:: wifi_disconnected_cb(); wifi_connect_by_wps_pbc(); wifi_connect_by_wps_pin(); wifi_connect()

int wifi_foreach_found_aps	(	wifi_found_ap_cb	callback,
		void *	user_data
	)

Gets the result of the scan.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Parameters:

[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_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_found_ap_cb().

int wifi_forget_ap ( wifi_ap_h ap )

Deletes the information of stored access point and disconnects it when it connected.

If an AP is connected, then connection information will be stored. This information is used when a connection to that AP is established automatically.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in] ap The access point handle

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

int wifi_get_connected_ap ( wifi_ap_h * ap )

Gets the handle of the connected access point.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Remarks:: You must release handle using wifi_ap_destroy().

Parameters:

[out] ap The access point handle

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_ERROR_NO_CONNECTION	There is no connected AP
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

int wifi_get_mac_address ( char ** mac_address )

Gets the local MAC address.

Since :: 2.3.1

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

Parameters:

[out] mac_address The MAC address

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_NOT_SUPPORTED	Not supported

int wifi_get_network_interface_name ( char ** name )

Gets the name of the network interface.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

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

Parameters:

[out] name The name of network interface

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OUT_OF_MEMORY	Out of memory
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

int wifi_is_activated ( bool * activated )

Checks whether Wi-Fi is activated.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Parameters:

[out] activated ture if Wi-Fi is activated, otherwise false if Wi-Fi is not activated.

Returns:: 0 on success, otherwise negative error value

Return values:

WIFI_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

int wifi_scan	(	wifi_scan_finished_cb	callback,
		void *	user_data
	)

Starts scan asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get

Remarks:: This API needs both privileges.

Parameters:

[in]	callback	The callback function 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_ERROR_NONE	Successful
WIFI_ERROR_INVALID_PARAMETER	Invalid parameter
WIFI_ERROR_INVALID_OPERATION	Invalid operation
WIFI_ERROR_OPERATION_FAILED	Operation failed
WIFI_ERROR_PERMISSION_DENIED	Permission Denied
WIFI_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes wifi_scan_finished_cb().

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation