|
Tizen Native API
10.0
|
The Wi-Fi API provides functions for managing Wi-Fi.
Required Header
#include <wifi-manager.h>
Overview
To utilize the Wi-fi Manager API, initially generate a wifi handle by invoking the 'wifi_manager_initialize()' function. Subsequently, you will be able to retrieve wifi information. If you no longer require the generated wifi handle, you must destroy it. The Wi-Fi Manager offers functionalities 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 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_activate (wifi_manager_h wifi, wifi_manager_activated_cb callback, void *user_data) |
| Activates Wi-Fi asynchronously. | |
| int | wifi_manager_activate_with_wifi_picker_tested (wifi_manager_h wifi, wifi_manager_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_manager_deactivate (wifi_manager_h wifi, wifi_manager_deactivated_cb callback, void *user_data) |
| Deactivates Wi-Fi asynchronously. | |
| int | wifi_manager_is_activated (wifi_manager_h wifi, bool *activated) |
| Checks whether Wi-Fi is activated. | |
| int | wifi_manager_get_mac_address (wifi_manager_h wifi, char **mac_address) |
| Gets the local MAC address. | |
| int | wifi_manager_get_network_interface_name (wifi_manager_h wifi, char **name) |
| Gets the name of the network interface. | |
| int | wifi_manager_scan (wifi_manager_h wifi, wifi_manager_scan_finished_cb callback, void *user_data) |
| Starts scan asynchronously. | |
| int | wifi_manager_get_scan_state (wifi_manager_h wifi, wifi_manager_scan_state_e *scan_state) |
| Gets the Wi-Fi scan state. | |
| int | wifi_manager_scan_specific_ap (wifi_manager_h wifi, const char *essid, wifi_manager_scan_finished_cb callback, void *user_data) |
| Starts specific AP scan, asynchronously. | |
| int | wifi_manager_specific_scan_create (wifi_manager_h wifi, wifi_manager_specific_scan_h *specific_scan) |
| Creates a Wi-Fi specific AP scan handle. | |
| int | wifi_manager_specific_scan_destroy (wifi_manager_h wifi, wifi_manager_specific_scan_h specific_scan) |
| Destroys a Wi-Fi specific AP scan handle. | |
| int | wifi_manager_specific_scan_get_max_ssids (wifi_manager_h wifi, int *max_scan_ssids) |
| Gets the maximum number of SSIDs supported by the Wi-Fi chipset for the scan operation. | |
| int | wifi_manager_specific_scan_set_ssid (wifi_manager_specific_scan_h specific_scan, const char *essid) |
| Sets the SSID of a specific AP scan. | |
| int | wifi_manager_specific_scan_set_freq (wifi_manager_specific_scan_h specific_scan, int freq) |
| Sets the channel frequency of a specific AP scan. | |
| int | wifi_manager_specific_ap_start_multi_scan (wifi_manager_h wifi, wifi_manager_specific_scan_h specific_scan, wifi_manager_scan_finished_cb callback, void *user_data) |
| Starts multi SSID and multi channel specific scan, asynchronously. | |
| int | wifi_manager_flush_bss (wifi_manager_h wifi) |
| Flushes BSS entries from the cache. | |
| int | wifi_manager_connect_hidden_ap (wifi_manager_h wifi, const char *essid, wifi_manager_security_type_e sec_type, const char *passphrase, wifi_manager_connected_cb callback, void *user_data) |
| Connects to the hidden AP, asynchronously. | |
| int | wifi_manager_get_connected_ap (wifi_manager_h wifi, wifi_manager_ap_h *ap) |
| Gets the handle of the connected access point. | |
| int | wifi_manager_foreach_found_ap (wifi_manager_h wifi, wifi_manager_found_ap_cb callback, void *user_data) |
| Gets the result of the scan. | |
| int | wifi_manager_foreach_found_specific_ap (wifi_manager_h wifi, wifi_manager_found_ap_cb callback, void *user_data) |
| Gets the result of specific AP scan. | |
| int | wifi_manager_foreach_found_bssid_ap (wifi_manager_h wifi, wifi_manager_found_ap_cb callback, void *user_data) |
| Gets the result of the BSSID scan (i.e. BSSID, ESSID & RSSI). | |
| int | wifi_manager_connect (wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_manager_connected_cb callback, void *user_data) |
| Connects to the access point asynchronously. | |
| int | wifi_manager_disconnect (wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_manager_disconnected_cb callback, void *user_data) |
| Disconnects to the access point asynchronously. | |
| int | wifi_manager_connect_by_wps_pbc (wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_manager_connected_cb callback, void *user_data) |
| Connects to the access point with WPS PBC asynchronously. | |
| int | wifi_manager_connect_by_wps_pin (wifi_manager_h wifi, wifi_manager_ap_h ap, const char *pin, wifi_manager_connected_cb callback, void *user_data) |
| Connects to the access point with WPS PIN asynchronously. | |
| int | wifi_manager_connect_by_wps_pbc_without_ssid (wifi_manager_h wifi, wifi_manager_connected_cb callback, void *user_data) |
| Connects to the access point with WPS PBC without entering SSID. | |
| int | wifi_manager_connect_by_wps_pin_without_ssid (wifi_manager_h wifi, const char *pin, wifi_manager_connected_cb callback, void *user_data) |
| Connects to the access point with WPS PIN without entering SSID. | |
| int | wifi_manager_cancel_wps (wifi_manager_h wifi) |
| Stops ongoing WPS provisioning / disconnects from the connected access point. | |
| int | wifi_manager_get_wps_generated_pin (wifi_manager_h wifi, char **wps_pin) |
| Gets the WPS generated PIN code. | |
| int | wifi_manager_forget_ap (wifi_manager_h wifi, wifi_manager_ap_h ap) |
| Deletes the information of a stored access point and disconnects from it if it was connected to. | |
| int | wifi_manager_forget_ap_async (wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_manager_forget_ap_finished_cb callback, void *user_data) |
| Deletes stored access point's information and disconnects from it if connected, asynchronously. | |
| int | wifi_manager_update_ap (wifi_manager_h wifi, wifi_manager_ap_h ap) |
| Updates an existing AP. | |
| int | wifi_manager_add_vsie (wifi_manager_h wifi, wifi_manager_vsie_frames_e frame_id, const char *vsie_str) |
| Adds the Wi-Fi Vendor Specific Information Element (VSIE) to a specific frame type. | |
| int | wifi_manager_get_vsie (wifi_manager_h wifi, wifi_manager_vsie_frames_e frame_id, char **vsie_str) |
| Gets the Wi-Fi Vendor Specific Information Elements (VSIE) from a specific frame. | |
| int | wifi_manager_remove_vsie (wifi_manager_h wifi, wifi_manager_vsie_frames_e frame_id, const char *vsie_str) |
| Removes the Wi-Fi Vendor Specific Information Element (VSIE) from specific frame. | |
Typedefs | |
| typedef void * | wifi_manager_specific_scan_h |
| The Wi-Fi specific ap scan handle. | |
| typedef bool(* | wifi_manager_found_ap_cb )(wifi_manager_ap_h ap, void *user_data) |
| Called for each found access point. | |
| typedef void(* | wifi_manager_scan_finished_cb )(wifi_manager_error_e error_code, void *user_data) |
| Called when the scan is finished. | |
| typedef void(* | wifi_manager_scan_state_changed_cb )(wifi_manager_scan_state_e state, void *user_data) |
| Called when the scanning state is changed. | |
| typedef void(* | wifi_manager_activated_cb )(wifi_manager_error_e result, void *user_data) |
| Called after wifi_manager_activate() or wifi_manager_activate_with_wifi_picker_tested() is completed. | |
| typedef void(* | wifi_manager_deactivated_cb )(wifi_manager_error_e result, void *user_data) |
| Called after wifi_manager_deactivate() is completed. | |
| typedef void(* | wifi_manager_connected_cb )(wifi_manager_error_e result, void *user_data) |
| Called when the connection process is completed. | |
| typedef void(* | wifi_manager_disconnected_cb )(wifi_manager_error_e result, void *user_data) |
| Called after wifi_manager_disconnect() is completed. | |
| typedef void(* | wifi_manager_forget_ap_finished_cb )(wifi_manager_error_e result, void *user_data) |
| Called after wifi_manager_forget_ap_async() is completed. | |
| typedef void(* | wifi_manager_bssid_scan_finished_cb )(wifi_manager_error_e error_code, void *user_data) |
| Called when the BSSID scan is finished. | |
Typedef Documentation
| typedef void(* wifi_manager_activated_cb)(wifi_manager_error_e result, void *user_data) |
Called after wifi_manager_activate() or wifi_manager_activate_with_wifi_picker_tested() is completed.
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
WIFI_MANAGER_ERROR_SECURITY_RESTRICTED Restricted by security system policy
- Since :
- 3.0
- Parameters:
-
[in] result The result [in] user_data The user data passed from wifi_manager_activate() and wifi_manager_activate_with_wifi_picker_tested()
- Precondition:
- wifi_manager_activate() or wifi_manager_activate_with_wifi_picker_tested() will invoke this callback function.
| typedef void(* wifi_manager_bssid_scan_finished_cb)(wifi_manager_error_e error_code, void *user_data) |
Called when the BSSID scan is finished.
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
- Since :
- 4.0
- Parameters:
-
[in] error_code The error code [in] user_data The user data passed from the callback registration function
| typedef void(* wifi_manager_connected_cb)(wifi_manager_error_e result, void *user_data) |
Called when the connection process is completed.
The following functions start the connection process and will result in the callback being called:
- wifi_manager_connect()
- wifi_manager_connect_by_wps_pbc()
- wifi_manager_connect_by_wps_pin()
- wifi_manager_connect_by_wps_pbc_without_ssid()
- wifi_manager_connect_by_wps_pin_without_ssid()
- wifi_manager_connect_hidden_ap()
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
WIFI_MANAGER_ERROR_OPERATION_ABORTED Operation aborted
WIFI_MANAGER_ERROR_ALREADY_EXISTS Connection already exists
WIFI_MANAGER_ERROR_OUT_OF_RANGE Out of range
WIFI_MANAGER_ERROR_DHCP_FAILED DHCP failed
WIFI_MANAGER_ERROR_CONNECT_FAILED Connect failed
WIFI_MANAGER_ERROR_LOGIN_FAILED Login failed
WIFI_MANAGER_ERROR_AUTHENTICATION_FAILED Authentication failed
WIFI_MANAGER_ERROR_ASSOCIATION_FAILED Association failed
WIFI_MANAGER_ERROR_INVALID_KEY Invalid key
WIFI_MANAGER_ERROR_PIN_MISSING PIN missing
WIFI_MANAGER_ERROR_WPS_OVERLAP WPS Overlap
WIFI_MANAGER_ERROR_WPS_TIMEOUT WPS Timeout
WIFI_MANAGER_ERROR_WPS_WEP_PROHIBITED WPS WEP Prohibited- Since :
- 3.0
- Parameters:
-
[in] result The result [in] user_data The user data passed from the connection function.
- Precondition:
- Any connection function will invoke this callback.
| typedef void(* wifi_manager_deactivated_cb)(wifi_manager_error_e result, void *user_data) |
Called after wifi_manager_deactivate() is completed.
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
WIFI_MANAGER_ERROR_SECURITY_RESTRICTED Restricted by security system policy
- Since :
- 3.0
- Parameters:
-
[in] result The result [in] user_data The user data passed from wifi_manager_deactivate()
- Precondition:
- wifi_manager_deactivate() will invoke this callback function.
- See also:
- wifi_manager_deactivate()
| typedef void(* wifi_manager_disconnected_cb)(wifi_manager_error_e result, void *user_data) |
Called after wifi_manager_disconnect() is completed.
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
- Since :
- 3.0
- Parameters:
-
[in] result The result [in] user_data The user data passed from wifi_manager_disconnect()
- Precondition:
- wifi_manager_disconnect() will invoke this callback function.
- See also:
- wifi_manager_disconnect()
| typedef void(* wifi_manager_forget_ap_finished_cb)(wifi_manager_error_e result, void *user_data) |
Called after wifi_manager_forget_ap_async() is completed.
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
- Since :
- 5.0
- Parameters:
-
[in] result The result [in] user_data The user data passed from wifi_manager_forget_ap_async()
- Precondition:
- wifi_manager_forget_ap_async() will invoke this callback function.
- See also:
- wifi_manager_forget_ap_async()
| typedef bool(* wifi_manager_found_ap_cb)(wifi_manager_ap_h ap, void *user_data) |
Called for each found access point.
This callback function is used in conjunction with `wifi_manager_foreach_found_ap()` or `wifi_manager_foreach_found_specific_ap()` to iterate through all discovered access points.
- Since :
- 3.0
- Remarks:
- ap is valid only in this function. In order to use ap outside this function, you must copy the ap with wifi_manager_ap_clone().
- Parameters:
-
[in] ap The access point [in] user_data The user data passed from the request function
- Returns:
trueto continue with the next iteration of the loop,
otherwisefalseto break out of the loop
- Precondition:
- wifi_manager_foreach_found_ap() will invoke this callback.
- wifi_manager_foreach_found_specific_ap() will invoke this callback.
| typedef void(* wifi_manager_scan_finished_cb)(wifi_manager_error_e error_code, void *user_data) |
Called when the scan is finished.
The following error codes can be received:
WIFI_MANAGER_ERROR_NONE Successful
WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed
- Since :
- 3.0
- Parameters:
-
[in] error_code The error code [in] user_data The user data passed from the callback registration function
| typedef void(* wifi_manager_scan_state_changed_cb)(wifi_manager_scan_state_e state, void *user_data) |
Called when the scanning state is changed.
This callback function is registered using `wifi_manager_set_scan_state_changed_cb()` and will be called whenever the scanning state of the Wi-Fi manager changes.
- Since :
- 4.0
- Parameters:
-
[in] state The wifi scanning state [in] user_data The user data passed from the callback registration function
| typedef void* wifi_manager_specific_scan_h |
The Wi-Fi specific ap scan handle.
- Since :
- 4.0
Enumeration Type Documentation
Enumeration for Wi-Fi Frame type.
- Since :
- 5.0
- Enumerator:
Function Documentation
| int wifi_manager_activate | ( | wifi_manager_h | wifi, |
| wifi_manager_activated_cb | callback, | ||
| void * | user_data | ||
| ) |
Activates Wi-Fi asynchronously.
This function initiates the process to activate the Wi-Fi service. When Wi-Fi is activated, the Wi-Fi radio is turned on, and the device becomes capable of connecting to wireless networks.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] callback The callback function to be called
This can beNULLif 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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_SECURITY_RESTRICTED Restricted by security system policy WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- wifi_manager_activated_cb() will be invoked.
| int wifi_manager_activate_with_wifi_picker_tested | ( | wifi_manager_h | wifi, |
| wifi_manager_activated_cb | callback, | ||
| void * | user_data | ||
| ) |
Activates Wi-Fi asynchronously and displays Wi-Fi picker (popup) when Wi-Fi is not automatically connected.
This function activates the Wi-Fi service and, if Wi-Fi does not automatically connect to a known network, it will display a Wi-Fi picker (popup) allowing the user to manually select a network to connect to.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] callback The callback function to be called
This can beNULLif 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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_SECURITY_RESTRICTED Restricted by security system policy WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- wifi_manager_activated_cb() will be invoked.
| int wifi_manager_add_vsie | ( | wifi_manager_h | wifi, |
| wifi_manager_vsie_frames_e | frame_id, | ||
| const char * | vsie_str | ||
| ) |
Adds the Wi-Fi Vendor Specific Information Element (VSIE) to a specific frame type.
This function adds the specified VSIE data to the given frame ID. The VSIE data will be included in the corresponding frame when transmitted by the Wi-Fi module.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
- Remarks:
- vsie_str for frame_id will be in effect until Wi-Fi is deactivated.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] frame_id The frame ID for setting VSIE [in] vsie_str The VSIE data
- 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_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- Wi-Fi service must be activated by wifi_manager_activate().
| int wifi_manager_cancel_wps | ( | wifi_manager_h | wifi | ) |
Stops ongoing WPS provisioning / disconnects from the connected access point.
This function stops any ongoing WPS provisioning process initiated by `wifi_manager_start_wps()` or disconnects from the currently connected access point if there is no ongoing WPS provisioning.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle
- 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_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
| int wifi_manager_connect | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap, | ||
| wifi_manager_connected_cb | callback, | ||
| void * | user_data | ||
| ) |
Connects to the access point asynchronously.
This function initiates a connection to the specified Wi-Fi access point. The connection process is performed asynchronously, meaning that the function returns immediately, and the result of the connection attempt is reported via the provided callback function.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] ap The access point handle [in] callback The callback function to be called
This can beNULLif 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_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_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_connected_cb().
| int wifi_manager_connect_by_wps_pbc | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap, | ||
| wifi_manager_connected_cb | callback, | ||
| void * | user_data | ||
| ) |
Connects to the access point with WPS PBC asynchronously.
This function initiates a connection to a Wi-Fi access point using WPS PBC authentication. The connection process is performed asynchronously, meaning that the function returns immediately, and the result of the connection attempt is reported via the provided callback function.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [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_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_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_connected_cb().
| int wifi_manager_connect_by_wps_pbc_without_ssid | ( | wifi_manager_h | wifi, |
| wifi_manager_connected_cb | callback, | ||
| void * | user_data | ||
| ) |
Connects to the access point with WPS PBC without entering SSID.
This function initiates a connection to a Wi-Fi access point using WPS PBC authentication. The SSID of the access point does not need to be known; the Wi-Fi module will search for and connect to the access point based on the WPS PBC signal.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
http://tizen.org/privilege/network.profile
- Remarks:
- This function needs all listed privileges.
- Parameters:
-
[in] wifi The Wi-Fi 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_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_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_connected_cb().
| int wifi_manager_connect_by_wps_pin | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap, | ||
| const char * | pin, | ||
| wifi_manager_connected_cb | callback, | ||
| void * | user_data | ||
| ) |
Connects to the access point with WPS PIN asynchronously.
This function initiates a connection to a Wi-Fi access point using WPS PIN authentication. The connection process is performed asynchronously, meaning that the function returns immediately, and the result of the connection attempt is reported via the provided callback function.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [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_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_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_connected_cb().
| int wifi_manager_connect_by_wps_pin_without_ssid | ( | wifi_manager_h | wifi, |
| const char * | pin, | ||
| wifi_manager_connected_cb | callback, | ||
| void * | user_data | ||
| ) |
Connects to the access point with WPS PIN without entering SSID.
This function initiates a connection to a Wi-Fi access point using WPS PIN authentication. The SSID of the access point does not need to be known; the Wi-Fi module will search for and connect to the access point based on the provided WPS PIN.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
http://tizen.org/privilege/network.profile
- Remarks:
- This function needs all listed privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] pin The WPS PIN, 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_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_NOW_IN_PROGRESS Now in progress WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_connected_cb().
| int wifi_manager_connect_hidden_ap | ( | wifi_manager_h | wifi, |
| const char * | essid, | ||
| wifi_manager_security_type_e | sec_type, | ||
| const char * | passphrase, | ||
| wifi_manager_connected_cb | callback, | ||
| void * | user_data | ||
| ) |
Connects to the hidden AP, asynchronously.
This function attempts to connect to a hidden Wi-Fi access point (AP) with the specified ESSID, security type, and passphrase. Hidden APs do not broadcast their presence, so the ESSID must be explicitly provided to the function. The connection process is performed asynchronously, meaning that the function returns immediately, and the result of the connection attempt is reported via the provided callback function.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
http://tizen.org/privilege/network.profile
- Remarks:
- This function needs all listed privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] essid The ESSID of the hidden AP [in] sec_type The security type of the hidden AP [in] passphrase The passphrase of the hidden AP [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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- This function needs wifi_manager_scan() before use.
- Postcondition:
- This function invokes wifi_manager_connected_cb().
| int wifi_manager_deactivate | ( | wifi_manager_h | wifi, |
| wifi_manager_deactivated_cb | callback, | ||
| void * | user_data | ||
| ) |
Deactivates Wi-Fi asynchronously.
This function initiates the process to deactivate the Wi-Fi service. When Wi-Fi is deactivated, the Wi-Fi radio is turned off, and the device will no longer be able to connect to wireless networks.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] callback The callback function to be called
This can beNULLif 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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- wifi_manager_deactivated_cb() will be invoked.
| int wifi_manager_disconnect | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap, | ||
| wifi_manager_disconnected_cb | callback, | ||
| void * | user_data | ||
| ) |
Disconnects to the access point asynchronously.
This function disrupts the existing connection to the specified Wi-Fi access point. The disconnection process is performed asynchronously, meaning that the function returns immediately, and the result of the disconnection attempt is reported via the provided callback function.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] ap The access point handle [in] callback The callback function to be called
This can beNULLif 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_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_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_disconnected_cb().
| int wifi_manager_flush_bss | ( | wifi_manager_h | wifi | ) |
Flushes BSS entries from the cache.
This function removes all previously discovered BSS entries from the Wi-Fi manager's internal cache. BSS entries include information about nearby Wi-Fi access points (APs) that have been scanned and stored by the Wi-Fi manager. By flushing these entries, the Wi-Fi manager effectively forgets about previously discovered APs, which can be useful in scenarios where the environment has changed significantly or when privacy concerns dictate that old scan results should be discarded.
- Since :
- 7.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle
- Returns:
- 0 on success, otherwise negative error value.
- Return values:
-
WIFI_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation
| int wifi_manager_foreach_found_ap | ( | wifi_manager_h | wifi, |
| wifi_manager_found_ap_cb | callback, | ||
| void * | user_data | ||
| ) |
Gets the result of the scan.
This function iterates through the list of access points found during a general Wi-Fi scan and provides their details to the caller via the provided callback function. A general Wi-Fi scan searches for all available access points in the vicinity, regardless of whether they are known or unknown to the device.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Parameters:
-
[in] wifi The Wi-Fi 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_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_found_ap_cb().
| int wifi_manager_foreach_found_bssid_ap | ( | wifi_manager_h | wifi, |
| wifi_manager_found_ap_cb | callback, | ||
| void * | user_data | ||
| ) |
Gets the result of the BSSID scan (i.e. BSSID, ESSID & RSSI).
This function iterates through the list of access points found during a BSSID scan and provides their details to the caller via the provided callback function. The BSSID scan focuses on identifying access points based on their unique MAC addresses (BSSID), allowing for more precise identification compared to a regular scan.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Parameters:
-
[in] wifi The Wi-Fi 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_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_found_ap_cb().
| int wifi_manager_foreach_found_specific_ap | ( | wifi_manager_h | wifi, |
| wifi_manager_found_ap_cb | callback, | ||
| void * | user_data | ||
| ) |
Gets the result of specific AP scan.
This function iterates through the list of access points found during a specific access point scan and provides their details to the caller via the provided callback function. A specific access point scan is used to focus on a particular access point, rather than scanning all available access points in the vicinity.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Parameters:
-
[in] wifi The Wi-Fi 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_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_found_ap_cb().
- See also:
- wifi_manager_scan_specific_ap()
| int wifi_manager_forget_ap | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap | ||
| ) |
Deletes the information of a stored access point and disconnects from it if it was connected to.
If an AP is connected to, then connection information will be stored. This information is used when a connection to that AP is established automatically.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] ap The access point handle
- 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_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
| int wifi_manager_forget_ap_async | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap, | ||
| wifi_manager_forget_ap_finished_cb | callback, | ||
| void * | user_data | ||
| ) |
Deletes stored access point's information and disconnects from it if connected, asynchronously.
This function initiates an asynchronous process to delete the stored information of the specified access point and disconnect from it if currently connected. The result of the operation is reported via the provided callback function.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] ap The access point handle [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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_forget_ap_finished_cb().
| int wifi_manager_get_connected_ap | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h * | ap | ||
| ) |
Gets the handle of the connected access point.
This function retrieves the handle of the access point to which the Wi-Fi interface is currently connected. If there is no active connection, the function will return an error.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Remarks:
- You must release ap using wifi_manager_ap_destroy().
- Parameters:
-
[in] wifi The Wi-Fi handle [out] ap The access point handle
- 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_OUT_OF_MEMORY Out of memory WIFI_MANAGER_ERROR_NO_CONNECTION There is no connected AP WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
| int wifi_manager_get_mac_address | ( | wifi_manager_h | wifi, |
| char ** | mac_address | ||
| ) |
Gets the local MAC address.
This function queries the Wi-Fi manager to obtain the MAC address of the Wi-Fi device. The MAC address is a unique identifier assigned to network interfaces for communications on a physical network segment.
- Since :
- 3.0
- Remarks:
- You must release mac_address using free().
- Parameters:
-
[in] wifi The Wi-Fi handle [out] mac_address The MAC 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_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
| int wifi_manager_get_network_interface_name | ( | wifi_manager_h | wifi, |
| char ** | name | ||
| ) |
Gets the name of the network interface.
This function queries the Wi-Fi manager to obtain the name of the network interface that is currently being used for the Wi-Fi connection. The network interface name is typically a string identifier like 'wlan0' or 'eth0', which can be used for various networking operations.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Remarks:
- You must release name using free().
- Parameters:
-
[in] wifi The Wi-Fi handle [out] name The name of network interface
- 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_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
| int wifi_manager_get_scan_state | ( | wifi_manager_h | wifi, |
| wifi_manager_scan_state_e * | scan_state | ||
| ) |
Gets the Wi-Fi scan state.
This function queries the Wi-Fi manager to determine the current state of the Wi-Fi scan operation. The scan state indicates whether a scan is currently in progress or if the results from the last scan are still valid.
- Since :
- 4.0
- Parameters:
-
[in] wifi The Wi-Fi handle [in] scan_state The Wi-Fi scan 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_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
| int wifi_manager_get_vsie | ( | wifi_manager_h | wifi, |
| wifi_manager_vsie_frames_e | frame_id, | ||
| char ** | vsie_str | ||
| ) |
Gets the Wi-Fi Vendor Specific Information Elements (VSIE) from a specific frame.
This function retrieves the VSIE data associated with the given frame ID. The retrieved VSIE data can be used to inspect or modify the contents of the VSIE element within the specified frame.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Remarks:
- vsie_str must be released with free().
- Parameters:
-
[in] wifi The Wi-Fi handle [in] frame_id The frame ID for getting VSIE [out] vsie_str The VSIE data
- 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_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- Wi-Fi service must be activated by wifi_manager_activate() and VSIE for a specific frame must be set with wifi_manager_add_vsie().
| int wifi_manager_get_wps_generated_pin | ( | wifi_manager_h | wifi, |
| char ** | wps_pin | ||
| ) |
Gets the WPS generated PIN code.
This function queries the Wi-Fi manager to obtain the WPS-generated PIN code. The retrieved PIN code can be used for WPS-based authentication when connecting to a Wi-Fi access point.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Remarks:
- You must release wps_pin using free().
- Parameters:
-
[in] wifi The Wi-Fi handle [out] wps_pin The WPS PIN
- 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
| int wifi_manager_is_activated | ( | wifi_manager_h | wifi, |
| bool * | activated | ||
| ) |
Checks whether Wi-Fi is activated.
This function checks the status of the Wi-Fi service to determine if it is currently activated. If Wi-Fi is activated, it means that the Wi-Fi radio is turned on and ready to connect to wireless networks.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Parameters:
-
[in] wifi The Wi-Fi handle [out] activated trueif Wi-Fi is activated, otherwisefalseif Wi-Fi is not activated.
- 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
| int wifi_manager_remove_vsie | ( | wifi_manager_h | wifi, |
| wifi_manager_vsie_frames_e | frame_id, | ||
| const char * | vsie_str | ||
| ) |
Removes the Wi-Fi Vendor Specific Information Element (VSIE) from specific frame.
This function removes the specified VSIE data from the given frame ID. The VSIE data will no longer be included in the corresponding frame when transmitted by the Wi-Fi module.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
- Remarks:
- vsie_str for frame_id will be in effect until Wi-Fi is deactivated.
- Parameters:
-
[in] wifi The wifi handle [in] frame_id The frame ID for removing VSIE [in] vsie_str The VSIE data
- 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_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- Wi-Fi service must be activated by wifi_manager_activate() and VSIE for a specific frame must be set with wifi_manager_add_vsie().
| int wifi_manager_scan | ( | wifi_manager_h | wifi, |
| wifi_manager_scan_finished_cb | callback, | ||
| void * | user_data | ||
| ) |
Starts scan asynchronously.
This function starts a Wi-Fi scan to discover all available access points (APs) in the vicinity. The scan results will include information about each detected AP, such as its SSID, signal strength, and security type.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_scan_finished_cb().
| int wifi_manager_scan_specific_ap | ( | wifi_manager_h | wifi, |
| const char * | essid, | ||
| wifi_manager_scan_finished_cb | callback, | ||
| void * | user_data | ||
| ) |
Starts specific AP scan, asynchronously.
This function starts a Wi-Fi scan targeting a specific access point (AP) with the given ESSID (Extended Service Set Identifier). Unlike a regular scan, which searches for all available APs in the vicinity, a specific scan focuses on a single AP with the specified ESSID, potentially improving scan performance and reducing scan time.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] essid The essid of specific AP [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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_scan_finished_cb().
| int wifi_manager_specific_ap_start_multi_scan | ( | wifi_manager_h | wifi, |
| wifi_manager_specific_scan_h | specific_scan, | ||
| wifi_manager_scan_finished_cb | callback, | ||
| void * | user_data | ||
| ) |
Starts multi SSID and multi channel specific scan, asynchronously.
This function starts a Wi-Fi scan targeting multiple specific access points (APs) across multiple channels simultaneously. Unlike a regular scan, which searches for all available APs in the vicinity, a specific scan focuses on a predefined set of APs, which can improve scan efficiency and reduce scan time. The multi-SSID and multi-channel specific scan extends this concept further by allowing the scan to target multiple sets of APs across different channels at once.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.set
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] specific_scan The Wi-Fi specific AP scan handle [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_MANAGER_ERROR_NONE Successful WIFI_MANAGER_ERROR_NOT_INITIALIZED Not initialized WIFI_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter WIFI_MANAGER_ERROR_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_OPERATION_FAILED Operation failed WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_OUT_OF_MEMORY Out of memory WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported
- Postcondition:
- This function invokes wifi_manager_scan_finished_cb().
| int wifi_manager_specific_scan_create | ( | wifi_manager_h | wifi, |
| wifi_manager_specific_scan_h * | specific_scan | ||
| ) |
Creates a Wi-Fi specific AP scan handle.
This function creates a new specific AP scan handle, which can be used to configure and initiate specific AP scans. The handle is required for setting up specific scan parameters such as SSID and channel frequency.
- Since :
- 4.0
- Remarks:
- You must release specific_scan using wifi_manager_specific_scan_destroy().
- Parameters:
-
[in] wifi The Wi-Fi handle [out] specific_scan The Wi-Fi specific AP scan handle
- 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
- Precondition:
- This function needs a wifi_manager_initialize() call before use.
- See also:
- wifi_manager_specific_scan_destroy()
| int wifi_manager_specific_scan_destroy | ( | wifi_manager_h | wifi, |
| wifi_manager_specific_scan_h | specific_scan | ||
| ) |
Destroys a Wi-Fi specific AP scan handle.
This function releases the memory allocated for a specific AP scan handle, which was created using `wifi_manager_specific_scan_create()`. It is important to destroy the handle when it is no longer needed to avoid memory leaks.
- Since :
- 4.0
- Parameters:
-
[in] wifi The Wi-Fi handle [in] specific_scan The Wi-Fi specific AP scan handle
- 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
- Precondition:
- This function needs a wifi_manager_initialize() call before use.
- See also:
- wifi_manager_specific_scan_create()
| int wifi_manager_specific_scan_get_max_ssids | ( | wifi_manager_h | wifi, |
| int * | max_scan_ssids | ||
| ) |
Gets the maximum number of SSIDs supported by the Wi-Fi chipset for the scan operation.
This function queries the Wi-Fi manager to determine the maximum number of SSIDs that the Wi-Fi chipset can support during a single scan operation. This value is important when configuring specific AP scans, as it limits the number of SSIDs that can be targeted in a single scan request.
- Since :
- 5.5
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.get
- Parameters:
-
[in] wifi The Wi-Fi handle [out] max_scan_ssids The maximum number of SSIDs supported by the Wi-Fi
chipset for the scan operation.
- 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
| int wifi_manager_specific_scan_set_freq | ( | wifi_manager_specific_scan_h | specific_scan, |
| int | freq | ||
| ) |
Sets the channel frequency of a specific AP scan.
This function sets the channel frequency for a specific AP scan, which determines the radio frequency band on which the scan will be performed. By specifying the channel frequency, the scan can be focused on a particular frequency band, potentially improving scan performance and reducing scan time.
- Since :
- 4.0
- Parameters:
-
[in] specific_scan The Wi-Fi specific AP scan handle [in] freq The channel frequency of specific AP scan
- 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_specific_scan_set_ssid | ( | wifi_manager_specific_scan_h | specific_scan, |
| const char * | essid | ||
| ) |
Sets the SSID of a specific AP scan.
This function sets the SSID for a specific AP scan, which determines the target access point to be scanned. By specifying the SSID, the scan can focus on a particular AP rather than scanning for all available APs in the vicinity, potentially improving scan performance and reducing scan time.
- Since :
- 4.0
- Parameters:
-
[in] specific_scan The Wi-Fi specific AP scan handle [in] essid The SSID of specific AP scan
- 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_update_ap | ( | wifi_manager_h | wifi, |
| wifi_manager_ap_h | ap | ||
| ) |
Updates an existing AP.
When a AP is changed, these changes will be not applied to the Connection Manager immediately. When you call this function, your changes affect the Connection Manager and the existing AP is updated.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/network.profile
http://tizen.org/privilege/network.get
- Remarks:
- This function needs both privileges.
- Parameters:
-
[in] wifi The Wi-Fi handle [in] ap The access point handle
- 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_INVALID_OPERATION Invalid operation WIFI_MANAGER_ERROR_PERMISSION_DENIED Permission Denied WIFI_MANAGER_ERROR_NOT_SUPPORTED Not supported