Tizen Native API  6.5
Functions | Typedefs
AP
Wi-Fi Management

The Access Point API provides functions for managing the Access Point.

Required Header

#include <wifi-manager.h>

Overview

The Access Point API provides functions for managing the Access Point. You need to create the ap handle for using the functions. You can use Wi-Fi information with the handle.

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_create (wifi_manager_h wifi, const char *essid, wifi_manager_ap_h *ap)
 Creates the access point handle.
int wifi_manager_ap_hidden_create (wifi_manager_h wifi, const char *essid, wifi_manager_ap_h *ap)
 Creates the hidden access point handle.
int wifi_manager_ap_destroy (wifi_manager_ap_h ap)
 Destroys the access point handle.
int wifi_manager_ap_clone (wifi_manager_ap_h *cloned_ap, wifi_manager_ap_h origin)
 Clones the access point handle.
int wifi_manager_ap_refresh (wifi_manager_ap_h ap)
 Refreshes the access point information.

Typedefs

typedef void * wifi_manager_ap_h
 The Wi-Fi access point handle.

Typedef Documentation

typedef void* wifi_manager_ap_h

The Wi-Fi access point handle.

Since :
3.0

Function Documentation

int wifi_manager_ap_clone ( wifi_manager_ap_h *  cloned_ap,
wifi_manager_ap_h  origin 
)

Clones the access point handle.

Since :
3.0
Remarks:
You must release cloned_ap using wifi_manager_ap_destroy().
Parameters:
[out]cloned_apThe cloned access point handle
[in]originThe origin access point handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_NOT_INITIALIZEDNot initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORYOut of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
See also:
wifi_manager_ap_destroy()
int wifi_manager_ap_create ( wifi_manager_h  wifi,
const char *  essid,
wifi_manager_ap_h *  ap 
)

Creates the access point handle.

Since :
3.0
Remarks:
You must release ap using wifi_manager_ap_destroy().
Parameters:
[in]wifiThe Wi-Fi handle
[in]essidThe ESSID (Extended Service Set Identifier) should be null-terminated and can be UTF-8 encoded
[out]apThe access point handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_NOT_INITIALIZEDNot initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORYOut of memory
WIFI_MANAGER_ERROR_PERMISSION_DENIEDPermission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
See also:
wifi_manager_ap_destroy()
int wifi_manager_ap_destroy ( wifi_manager_ap_h  ap)

Destroys the access point handle.

Since :
3.0
Parameters:
[in]apThe access point handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
See also:
wifi_manager_ap_create()
int wifi_manager_ap_hidden_create ( wifi_manager_h  wifi,
const char *  essid,
wifi_manager_ap_h *  ap 
)

Creates the hidden access point handle.

Since :
3.0
Remarks:
You must release ap using wifi_manager_ap_destroy().
Parameters:
[in]wifiThe Wi-Fi handle
[in]essidThe ESSID (Extended Service Set Identifier) should be null-terminated and can be UTF-8 encoded
[out]apThe access point handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_NOT_INITIALIZEDNot initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OUT_OF_MEMORYOut of memory
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported
See also:
wifi_manager_ap_destroy()
int wifi_manager_ap_refresh ( wifi_manager_ap_h  ap)

Refreshes the access point information.

Since :
3.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/network.get
Remarks:
You should call this function in order to get the current access point information, because the information can be changed.
Parameters:
[in]apThe access point handle
Returns:
0 on success, otherwise negative error value
Return values:
WIFI_MANAGER_ERROR_NONESuccessful
WIFI_MANAGER_ERROR_NOT_INITIALIZEDNot initialized
WIFI_MANAGER_ERROR_INVALID_PARAMETERInvalid parameter
WIFI_MANAGER_ERROR_OPERATION_FAILEDOperation failed
WIFI_MANAGER_ERROR_OUT_OF_MEMORYOut of memory
WIFI_MANAGER_ERROR_PERMISSION_DENIEDPermission Denied
WIFI_MANAGER_ERROR_NOT_SUPPORTEDNot supported