SoftAP Manager API provides functions to manage the SoftAP.

Required Header

#include <softap.h>

Overview

The SoftAP Manager module allows Tizen-based devices to set up and manage their own Soft Access Point (SoftAP). With this functionality, a device can create its own network and enable other client devices to connect to it. The module provides easy control over network creation, configuration, and security protocols, simplifying SoftAP management.

Related Features

This API is related with the following features:

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

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	softap_create (softap_h *softap)
	Creates the handle for SoftAP.
int	softap_destroy (softap_h softap)
	Destroys the handle for SoftAP.
int	softap_enable (softap_h softap)
	Enables the SoftAP, asynchronously.
int	softap_disable (softap_h softap)
	Disables the SoftAP, asynchronously.
int	softap_is_enabled (softap_h softap, bool *enable)
	Checks whether the SoftAP is enabled or not.
int	softap_get_mac_address (softap_h softap, char **mac_address)
	Gets the Media Access Control (MAC) address of the local device in the format "FC:A1:3E:D6:B1:B1".
int	softap_get_network_interface_name (softap_h softap, char **interface_name)
	Gets the name of network interface (e.g. wlan0).
int	softap_set_ip_address (softap_h softap, softap_address_family_e address_family, const char *ip_address)
	Sets the local IP address.
int	softap_get_ip_address (softap_h softap, softap_address_family_e address_family, char **ip_address)
	Gets the local IP address.
int	softap_get_gateway_address (softap_h softap, softap_address_family_e address_family, char **gateway_address)
	Gets the Gateway address.
int	softap_get_subnet_mask (softap_h softap, softap_address_family_e address_family, char **subnet_mask)
	Gets the Subnet Mask.
int	softap_foreach_connected_clients (softap_h softap, softap_connected_client_cb callback, void *user_data)
	Gets the clients which are connected.
int	softap_set_enabled_cb (softap_h softap, softap_enabled_cb callback, void *user_data)
	Sets a callback function to be called when the SoftAP is enabled.
int	softap_unset_enabled_cb (softap_h softap)
	Unsets the callback function, which is called when SoftAP is enabled.
int	softap_set_disabled_cb (softap_h softap, softap_disabled_cb callback, void *user_data)
	Sets the callback function called when SoftAP is disabled.
int	softap_unset_disabled_cb (softap_h softap)
	Unsets the callback function, which is called when SoftAP is disabled.
int	softap_set_client_connection_state_changed_cb (softap_h softap, softap_client_connection_state_changed_cb callback, void *user_data)
	Sets the callback function, which is called when the state of connection is changed.
int	softap_unset_client_connection_state_changed_cb (softap_h softap)
	Unsets the callback function, which is called when the state of connection is changed.
int	softap_set_security_type_changed_cb (softap_h softap, softap_security_type_changed_cb callback, void *user_data)
	Sets the callback function, which is called when the security type of SoftAP is changed.
int	softap_unset_security_type_changed_cb (softap_h softap)
	Unsets the callback function, which is called when the security type of SoftAP is changed.
int	softap_set_ssid_visibility_changed_cb (softap_h softap, softap_ssid_visibility_changed_cb callback, void *user_data)
	Sets the callback function , which is called when the visibility of SSID is changed.
int	softap_unset_ssid_visibility_changed_cb (softap_h softap)
	Unsets the callback function, which is called when the visibility of SSID is changed.
int	softap_set_passphrase_changed_cb (softap_h softap, softap_passphrase_changed_cb callback, void *user_data)
	Sets the callback function, which is called when the passphrase of SoftAP is changed.
int	softap_unset_passphrase_changed_cb (softap_h softap)
	Unsets the callback function, which is called when the passphrase of SoftAP is changed.
int	softap_set_security_type (softap_h softap, softap_security_type_e type)
	Sets the security type of SoftAP.
int	softap_get_security_type (softap_h softap, softap_security_type_e *type)
	Gets the security type of SoftAP.
int	softap_set_ssid (softap_h softap, const char *ssid)
	Sets the SSID (service set identifier) for SoftAP.
int	softap_get_ssid (softap_h softap, char **ssid)
	Gets the SSID (service set identifier) for SoftAP.
int	softap_set_ssid_visibility (softap_h softap, bool visible)
	Sets the visibility of SSID (service set identifier) for SoftAP.
int	softap_get_ssid_visibility (softap_h softap, bool *visible)
	Gets the visibility of SSID (service set identifier) for SoftAP.
int	softap_set_passphrase (softap_h softap, const char *passphrase)
	Sets the passphrase for SoftAP.
int	softap_get_passphrase (softap_h softap, char **passphrase)
	Gets the passphrase for SoftAP.
int	softap_reload_settings (softap_h softap, softap_settings_reloaded_cb callback, void *user_data)
	Reloads the settings (SSID / Passphrase / Security type / SSID visibility) for SoftAP.
int	softap_push_wps_button (softap_h softap)
	Pushes the WPS button to connect with SoftAP client(WPS PBC).
int	softap_set_wps_pin (softap_h softap, const char *wps_pin)
	Sets the WPS PIN to connect with SoftAP client(WPS PIN).
int	softap_set_vendor_element (softap_h softap, const char *vendor_element)
	Sets vendor specific elements for Beacon and Probe Response frames.
int	softap_get_vendor_element (softap_h softap, char **vendor_element)
	Gets vendor specific elements for Beacon and Probe Response frames.
int	softap_set_channel (softap_h softap, int channel)
	Sets the channel for SoftAP.
int	softap_get_channel (softap_h softap, int *channel)
	Gets the channel for SoftAP.
int	softap_enable_dhcp (softap_h softap)
	Enables the DHCP server.
int	softap_disable_dhcp (softap_h softap)
	Disables the DHCP server.
int	softap_is_dhcp_enabled (softap_h softap, bool *dhcp_enabled)
	Checks whether the DHCP is enabled or not.
int	softap_enable_dhcp_with_range (softap_h softap, char rangestart, char rangestop)
	Enables the DHCP server with the address range.
int	softap_set_mode (softap_h softap, softap_wireless_mode_e mode)
	Sets the wireless mode for SoftAP.
int	softap_get_mode (softap_h softap, softap_wireless_mode_e *mode)
	Gets the wireless mode for SoftAP.
Typedefs
typedef void *	softap_h
	The SoftAP handle.
typedef void(*	softap_enabled_cb )(softap_error_e result, bool is_requested, void *user_data)
	Called when the SoftAP is enabled.
typedef void(*	softap_disabled_cb )(softap_error_e result, softap_disabled_cause_e cause, void *user_data)
	Called when the SoftAP is disabled.
typedef void(*	softap_client_connection_state_changed_cb )(softap_client_h client, bool opened, void *user_data)
	Called when the connection state is changed.
typedef bool(*	softap_connected_client_cb )(softap_client_h client, void *user_data)
	Called when you get the connected client repeatedly.
typedef void(*	softap_security_type_changed_cb )(softap_security_type_e changed_type, void *user_data)
	Called when the security type of SoftAP is changed.
typedef void(*	softap_ssid_visibility_changed_cb )(bool changed_visible, void *user_data)
	Called when the visibility of SSID is changed.
typedef void(*	softap_passphrase_changed_cb )(void *user_data)
	Called when the passphrase is changed.
typedef void(*	softap_settings_reloaded_cb )(softap_error_e result, void *user_data)
	Called when SoftAP settings are reloaded.

Typedef Documentation

typedef void(* softap_client_connection_state_changed_cb)(softap_client_h client, bool opened, void *user_data)

Called when the connection state is changed.

Since :: 5.0

Remarks:: The client should not be released by the application and it is valid only in this function.
In order to use it outside this function, a user must copy the client with softap_client_clone().

Parameters:

[in]	client	The client of which connection state is changed
[in]	opened	`true` when connection is opened, otherwise false
[in]	user_data	The user data passed from softap_set_client_connection_state_changed_cb()

Precondition:: If you register callback function using softap_set_client_connection_state_changed_cb(), this will be invoked when the connection state is changed.

See also:: softap_set_client_connection_state_changed_cb(); softap_unset_client_connection_state_changed_cb()

typedef bool(* softap_connected_client_cb)(softap_client_h client, void *user_data)

Called when you get the connected client repeatedly.

Since :: 5.0

Remarks:: The client should not be released by the application and it is valid only in this function.
In order to use the client outside this function, a user must copy the client with softap_client_clone().

Parameters:

[in]	client	The connected client
[in]	user_data	The user data passed from the request function

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

Precondition:: softap_foreach_connected_clients() will invoke this callback.

See also:: softap_foreach_connected_clients()

typedef void(* softap_disabled_cb)(softap_error_e result, softap_disabled_cause_e cause, void *user_data)

Called when the SoftAP is disabled.

The following error codes can be received:
SOFTAP_ERROR_NONE: Success
SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory
SOFTAP_ERROR_OPERATION_FAILED: Operation failed

Since :: 5.0

Parameters:

[in]	result	The result of disabling the SoftAP
[in]	cause	The cause of disabling
[in]	user_data	The user data passed from softap_set_disabled_cb()

Precondition:: If you register callback function using softap_set_disabled_cb(), this will be invoked when the SoftAP is disabled.

See also:: softap_set_disabled_cb(); softap_unset_disabled_cb()

typedef void(* softap_enabled_cb)(softap_error_e result, bool is_requested, void *user_data)

Called when the SoftAP is enabled.

The following error codes can be received:
SOFTAP_ERROR_NONE: Success
SOFTAP_ERROR_NOT_PERMITTED: Operation not permitted
SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory
SOFTAP_ERROR_OPERATION_FAILED: Operation failed
SOFTAP_ERROR_ALREADY_ENABLED: Already enabled

Since :: 5.0

Parameters:

[in]	result	The result of enabling the SoftAP
[in]	is_requested	Indicates whether this change is requested
[in]	user_data	The user data passed from softap_set_enabled_cb()

Precondition:: If you register callback function using softap_set_enabled_cb(), this will be invoked when the SoftAP is enabled.

See also:: softap_enable(); softap_unset_enabled_cb()

typedef void* softap_h

The SoftAP handle.

Since :: 5.0

typedef void(* softap_passphrase_changed_cb)(void *user_data)

Called when the passphrase is changed.

Since :: 5.0

Parameters:

[in] user_data The user data passed from the register function

See also:: softap_set_passphrase_changed_cb(); softap_unset_passphrase_changed_cb()

typedef void(* softap_security_type_changed_cb)(softap_security_type_e changed_type, void *user_data)

Called when the security type of SoftAP is changed.

Since :: 5.0

Parameters:

[in]	changed_type	The changed security type
[in]	user_data	The user data passed from the register function

See also:: softap_set_security_type_changed_cb(); softap_unset_security_type_changed_cb()

typedef void(* softap_settings_reloaded_cb)(softap_error_e result, void *user_data)

Called when SoftAP settings are reloaded.

The following error codes can be received:
SOFTAP_ERROR_NONE: Success
SOFTAP_ERROR_NOT_PERMITTED: Operation not permitted
SOFTAP_ERROR_INVALID_PARAMETER: Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY: Out of memory
SOFTAP_ERROR_OPERATION_FAILED: Operation failed

Since :: 5.0

Parameters:

[in]	result	The result of reloading the settings
[in]	user_data	The user data passed from the request function

Precondition:: softap_reload_settings() will invoke this callback.

typedef void(* softap_ssid_visibility_changed_cb)(bool changed_visible, void *user_data)

Called when the visibility of SSID is changed.

Since :: 5.0

Parameters:

[in]	changed_visible	The changed visibility of SSID
[in]	user_data	The user data passed from the register function

See also:: softap_set_ssid_visibility_changed_cb(); softap_unset_ssid_visibility_changed_cb()

Enumeration Type Documentation

enum softap_disabled_cause_e

Enumeration for the cause of disabling the SoftAP.

Since :: 5.0

Enumerator:

SOFTAP_DISABLED_BY_FLIGHT_MODE	Disabled due to flight mode
SOFTAP_DISABLED_BY_LOW_BATTERY	Disabled due to low battery
SOFTAP_DISABLED_BY_NETWORK_CLOSE	Disabled due to pdp network close
SOFTAP_DISABLED_BY_TIMEOUT	Disabled due to timeout
SOFTAP_DISABLED_BY_OTHERS	Disabled by other apps
SOFTAP_DISABLED_BY_REQUEST	Disabled by your request
SOFTAP_DISABLED_BY_WIFI_ON	Disabled due to Wi-Fi on

enum softap_error_e

Enumeration for the SoftAP.

Since :: 5.0

Enumerator:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_NOT_PERMITTED	Operation not permitted
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_RESOURCE_BUSY	Resource busy
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_ALREADY_ENABLED	Already enabled
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

enum softap_security_type_e

Enumeration for the SoftAP security.

Since :: 5.0

Enumerator:

SOFTAP_SECURITY_TYPE_NONE	No Security type
SOFTAP_SECURITY_TYPE_WPA2_PSK	WPA2_PSK
SOFTAP_SECURITY_TYPE_WPS	WPS

enum softap_wireless_mode_e

Enumeration for the SoftAP HW mode.

Since :: 5.0

Enumerator:

SOFTAP_WIRELESS_MODE_B	IEEE 802.11b
SOFTAP_WIRELESS_MODE_G	IEEE 802.11g
SOFTAP_WIRELESS_MODE_A	IEEE 802.11a
SOFTAP_WIRELESS_MODE_AD	IEEE 802.11ad

Function Documentation

int softap_create ( softap_h * softap )

Creates the handle for SoftAP.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The softap should be released using softap_destroy().

Parameters:

[out] softap A handle of a new mobile ap handle on success

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_destroy()

int softap_destroy ( softap_h softap )

Destroys the handle for SoftAP.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_create()

int softap_disable ( softap_h softap )

Disables the SoftAP, asynchronously.

Warning:: This is not for use by third-party applications.

This function enables you to deactivate the SoftAP functionality on the device. Upon successful execution, the SoftAP will be disabled, preventing further wireless connections from being established.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/softap.admin

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Postcondition:: softap_disabled_cb() will be invoked.

See also:: softap_is_enabled(); softap_enable()

int softap_disable_dhcp ( softap_h softap )

Disables the DHCP server.

Enable/disable the DHCP server.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_enable_dhcp(); softap_enable_dhcp_with_range()

int softap_enable ( softap_h softap )

Enables the SoftAP, asynchronously.

Warning:: This is not for use by third-party applications.

This function allows you to activate the SoftAP functionality on the device. It's important to ensure that the required privileges have been obtained before invoking this function, as mentioned in the precondition. Upon successful execution, the SoftAP will be enabled, allowing nearby devices to establish wireless connections. Depending on the device, the user might need to manually turn off the current Wi-Fi connection before enabling the SoftAP.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/softap.admin

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_NOT_PERMITTED	Operation not permitted
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_RESOURCE_BUSY	Device or resource busy
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Postcondition:: softap_enabled_cb() will be invoked.

See also:: softap_is_enabled(); softap_disable()

int softap_enable_dhcp ( softap_h softap )

Enables the DHCP server.

Enable/disable the DHCP server.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_disable_dhcp()

int softap_enable_dhcp_with_range	(	softap_h	softap,
		char *	rangestart,
		char *	rangestop
	)

Enables the DHCP server with the address range.

Enable the DHCP server with the address range.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The handle of softap
[in]	rangestart	Start address range
[in]	rangestop	End address range

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_disable_dhcp()

int softap_foreach_connected_clients	(	softap_h	softap,
		softap_connected_client_cb	callback,
		void *	user_data
	)

Gets the clients which are connected.

This function allows you to enumerate the clients that are currently connected to the SoftAP. By providing the appropriate SoftAP handle as the 'softap' argument and specifying the callback function and user data, you can receive information about each connected client. Upon successful execution, the callback function will be called for each connected client, giving you the opportunity to perform actions based on the received client information.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Precondition:: The SoftAP must be enabled.

See also:: softap_is_enabled(); softap_enable()

int softap_get_channel	(	softap_h	softap,
		int *	channel
	)

Gets the channel for SoftAP.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[out]	channel	The channel number

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_channel()

int softap_get_gateway_address	(	softap_h	softap,
		softap_address_family_e	address_family,
		char **	gateway_address
	)

Gets the Gateway address.

This function retrieves the gateway address of the SoftAP. Remember that the SoftAP must be enabled in order to use this function. You can verify the SoftAP's activation state using the 'softap_is_enabled' function. Upon successful execution, the gateway address will be returned as a string, which should be freed using the 'free' function once it's no longer needed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The gateway_address should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[in]	address_family	The address family of IP address (currently only SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
[out]	gateway_address	Gateway address

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Precondition:: The SoftAP must be enabled.

See also:: softap_is_enabled(); softap_enable()

int softap_get_ip_address	(	softap_h	softap,
		softap_address_family_e	address_family,
		char **	ip_address
	)

Gets the local IP address.

This function retrieves the IP address of the SoftAP. Remember that the SoftAP must be enabled in order to use this function. You can verify the SoftAP's activation state using the 'softap_is_enabled' function. Upon successful execution, the IP address will be returned as a string, which should be freed using the 'free' function once it's no longer needed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The ip_address should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[in]	address_family	The address family of IP address (currently only SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
[out]	ip_address	The local IP address

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Precondition:: The SoftAP must be enabled.

See also:: softap_is_enabled(); softap_enable()

int softap_get_mac_address	(	softap_h	softap,
		char **	mac_address
	)

Gets the Media Access Control (MAC) address of the local device in the format "FC:A1:3E:D6:B1:B1".

This function allows you to obtain the MAC address of the local device. Remember that the SoftAP must be enabled in order to use this function. You can verify the SoftAP's activation state using the 'softap_is_enabled' function. Upon successful execution, the MAC address will be returned in the form of a string, which should be freed using the 'free' function once it's no longer needed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The mac_address should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[out]	mac_address	The MAC address

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Precondition:: The SoftAP must be enabled.

See also:: softap_is_enabled(); softap_enable()

int softap_get_mode	(	softap_h	softap,
		softap_wireless_mode_e *	mode
	)

Gets the wireless mode for SoftAP.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[out]	mode	The wireless mode

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_mode()

int softap_get_network_interface_name	(	softap_h	softap,
		char **	interface_name
	)

Gets the name of network interface (e.g. wlan0).

This function enables you to retrieve the name of the network interface associated with the SoftAP functionality. Remember that the SoftAP must be enabled in order to use this function. You can verify the SoftAP's activation state using the 'softap_is_enabled' function. Upon successful execution, the name of the network interface will be returned as a string, which should be freed using the 'free' function once it's no longer needed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The interface_name should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[out]	interface_name	The name of the network interface

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Precondition:: The SoftAP must be enabled.

See also:: softap_is_enabled(); softap_enable()

int softap_get_passphrase	(	softap_h	softap,
		char **	passphrase
	)

Gets the passphrase for SoftAP.

If the passphrase is not set, random string of 8 characters will be used.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The passphrase should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[out]	passphrase	The passphrase

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_passphrase()

int softap_get_security_type	(	softap_h	softap,
		softap_security_type_e *	type
	)

Gets the security type of SoftAP.

If security type is not set, WPA2_PSK is used.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[out]	type	The security type

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_security_type()

int softap_get_ssid	(	softap_h	softap,
		char **	ssid
	)

Gets the SSID (service set identifier) for SoftAP.

If SSID is not set, Device name is used as SSID.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The ssid should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[out]	ssid	The SSID

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_ssid()

int softap_get_ssid_visibility	(	softap_h	softap,
		bool *	visible
	)

Gets the visibility of SSID (service set identifier) for SoftAP.

If the visibility is set to invisible, then the SSID of this device is hidden and Wi-Fi scan won't find your device.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[out]	visible	The visibility of SSID: (`true` = visible, `false` = invisible)

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_ssid_visibility()

int softap_get_subnet_mask	(	softap_h	softap,
		softap_address_family_e	address_family,
		char **	subnet_mask
	)

Gets the Subnet Mask.

This function retrieves the subnet mask of the SoftAP. Remember that the SoftAP must be enabled in order to use this function. You can verify the SoftAP's activation state using the 'softap_is_enabled' function. Upon successful execution, the subnet mask will be returned as a string, which should be freed using the 'free' function once it's no longer needed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The subnet_mask should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[in]	address_family	The address family of IP address (currently only SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
[out]	subnet_mask	Subnet mask

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_INVALID_OPERATION	Invalid operation
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

Precondition:: The SoftAP must be enabled.

See also:: softap_is_enabled(); softap_enable()

int softap_get_vendor_element	(	softap_h	softap,
		char **	vendor_element
	)

Gets vendor specific elements for Beacon and Probe Response frames.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The format for vendor parameter should be a hex dump of the raw information elements.
The vendor_element should be released using free().

Parameters:

[in]	softap	The SoftAP handle
[out]	vendor_element	The vendor specific elements

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_vendor_element()

int softap_is_dhcp_enabled	(	softap_h	softap,
		bool *	dhcp_enabled
	)

Checks whether the DHCP is enabled or not.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[out]	dhcp_enabled	`true` if DHCP is enabled, `false` if DHCP is disabled

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

int softap_is_enabled	(	softap_h	softap,
		bool *	enable
	)

Checks whether the SoftAP is enabled or not.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[out]	enable	`true` if SoftAP is enabled, `false` if SoftAP is disabled

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

int softap_push_wps_button ( softap_h softap )

Pushes the WPS button to connect with SoftAP client(WPS PBC).

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The WPS button should be pushed when client tries to connect with SoftAP by using WPS PBC.

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

int softap_reload_settings	(	softap_h	softap,
		softap_settings_reloaded_cb	callback,
		void *	user_data
	)

Reloads the settings (SSID / Passphrase / Security type / SSID visibility) for SoftAP.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/softap.admin

Remarks:: Devices connected via MobileAP will be disconnected when the settings are reloaded.

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_RESOURCE_BUSY	Device or resource busy
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

int softap_set_channel	(	softap_h	softap,
		int	channel
	)

Sets the channel for SoftAP.

If channel is not set, channel 1 is used as default.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: This change is applied next time SoftAP is enabled.
You can use softap_enable() or softap_reload_settings() to enable SoftAP.
If channel is 0, the channel can be selected automatically at run time.
(ACS: Automatic Channel Selection)

Parameters:

[in]	softap	The SoftAP handle
[in]	channel	The channel number

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_channel()

int softap_set_client_connection_state_changed_cb	(	softap_h	softap,
		softap_client_connection_state_changed_cb	callback,
		void *	user_data
	)

Sets the callback function, which is called when the state of connection is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_unset_client_connection_state_changed_cb()

int softap_set_disabled_cb	(	softap_h	softap,
		softap_disabled_cb	callback,
		void *	user_data
	)

Sets the callback function called when SoftAP is disabled.

This function allows you to associate a callback function with the SoftAP handle, which will be invoked when the SoftAP is successfully disabled. By providing the appropriate SoftAP handle as the'softap' argument and specifying the callback function and user data, you can receive notification regarding the SoftAP's deactivation status. Upon successful execution, the callback function will be registered, ensuring that your application receives timely updates regarding the SoftAP's disabling process.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_unset_disabled_cb()

int softap_set_enabled_cb	(	softap_h	softap,
		softap_enabled_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when the SoftAP is enabled.

This function allows you to associate a callback function with the SoftAP handle, which will be invoked when the SoftAP is successfully enabled or when an error occurs during the enabling process. By providing the appropriate SoftAP handle as the 'softap' argument and specifying the callback function and user data, you can receive notification regarding the SoftAP's activation status. Upon successful execution, the callback function will be registered, ensuring that your application receives timely updates regarding the SoftAP's enabling process.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_unset_enabled_cb(); softap_enable()

int softap_set_ip_address	(	softap_h	softap,
		softap_address_family_e	address_family,
		const char *	ip_address
	)

Sets the local IP address.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: This change is applied next time SoftAP is enabled. You can use softap_enable() or softap_reload_settings() to enable SoftAP.

Parameters:

[in]	softap	The SoftAP handle
[in]	address_family	The address family of IP address (currently only SOFTAP_ADDRESS_FAMILY_IPV4 is supported)
[in]	ip_address	The local IP address

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

int softap_set_mode	(	softap_h	softap,
		softap_wireless_mode_e	mode
	)

Sets the wireless mode for SoftAP.

If wireless mode is not set, IEEE 802.11g is used as default.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	mode	The mode

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_mode()

int softap_set_passphrase	(	softap_h	softap,
		const char *	passphrase
	)

Sets the passphrase for SoftAP.

If the passphrase is not set, random string of 8 characters is used.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: This change is applied next time SoftAP is enabled.
You can use softap_enable() or softap_reload_settings() to enable SoftAP.

Parameters:

[in]	softap	The SoftAP handle
[in]	passphrase	The passphrase

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_passphrase()

int softap_set_passphrase_changed_cb	(	softap_h	softap,
		softap_passphrase_changed_cb	callback,
		void *	user_data
	)

Sets the callback function, which is called when the passphrase of SoftAP is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_unset_passphrase_changed_cb()

int softap_set_security_type	(	softap_h	softap,
		softap_security_type_e	type
	)

Sets the security type of SoftAP.

If security type is not set, WPA2_PSK is used.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: This change is applied next time SoftAP is enabled. \ You can use softap_enable() or softap_reload_settings() to enable SoftAP.

Parameters:

[in]	softap	The SoftAP handle
[in]	type	The security type

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_security_type()

int softap_set_security_type_changed_cb	(	softap_h	softap,
		softap_security_type_changed_cb	callback,
		void *	user_data
	)

Sets the callback function, which is called when the security type of SoftAP is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_unset_security_type_changed_cb()

int softap_set_ssid	(	softap_h	softap,
		const char *	ssid
	)

Sets the SSID (service set identifier) for SoftAP.

The SSID cannot exceed 32 bytes. If SSID is not set, device name is used as SSID.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: This change is applied next time SoftAP is enabled.
You can use softap_enable() or softap_reload_settings() to enable SoftAP.

Parameters:

[in]	softap	The SoftAP handle
[in]	ssid	The SSID

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OUT_OF_MEMORY	Out of memory
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_ssid()

int softap_set_ssid_visibility	(	softap_h	softap,
		bool	visible
	)

Sets the visibility of SSID (service set identifier) for SoftAP.

If you set the visibility to invisible, then the SSID of this device is hidden and Wi-Fi scan won't find your device.

By default visibility is set to true.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: This change is applied next time SoftAP is enabled.
You can use softap_enable() or softap_reload_settings() to enable SoftAP.

Parameters:

[in]	softap	The SoftAP handle
[in]	visible	The visibility of SSID: (`true` = visible, `false` = invisible)

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_ssid_visibility()

int softap_set_ssid_visibility_changed_cb	(	softap_h	softap,
		softap_ssid_visibility_changed_cb	callback,
		void *	user_data
	)

Sets the callback function , which is called when the visibility of SSID is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in]	softap	The SoftAP handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_unset_ssid_visibility_changed_cb()

int softap_set_vendor_element	(	softap_h	softap,
		const char *	vendor_element
	)

Sets vendor specific elements for Beacon and Probe Response frames.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The format for vendor parameter should be a hex dump of the raw information elements.
This change is applied next time SoftAP is enabled.
You can use softap_enable() or softap_reload_settings() to enable SoftAP.

Parameters:

[in]	softap	The SoftAP handle
[in]	vendor_element	The vendor specific elements

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_get_vendor_element()

int softap_set_wps_pin	(	softap_h	softap,
		const char *	wps_pin
	)

Sets the WPS PIN to connect with SoftAP client(WPS PIN).

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Remarks:: The WPS PIN should be inserted when client tries to connect with SoftAP by using WPS PIN.

Parameters:

[in]	softap	The SoftAP handle
[in]	wps_pin	The WPS PIN

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_OPERATION_FAILED	Operation failed
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

int softap_unset_client_connection_state_changed_cb ( softap_h softap )

Unsets the callback function, which is called when the state of connection is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_client_connection_state_changed_cb()

int softap_unset_disabled_cb ( softap_h softap )

Unsets the callback function, which is called when SoftAP is disabled.

This function enables you to dissociate the callback function from the SoftAP handle, preventing it from receiving notifications regarding the SoftAP's deactivation status. By providing the appropriate SoftAP handle as the'softap' argument, you can initiate the unregistration process. Upon successful execution, the callback function will be unregistered, allowing your application to focus solely on other aspects of the SoftAP functionality.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_disabled_cb()

int softap_unset_enabled_cb ( softap_h softap )

Unsets the callback function, which is called when SoftAP is enabled.

This function enables you to unregister the callback function from the SoftAP handle, preventing it from receiving notifications regarding the SoftAP's activation status. By providing the appropriate SoftAP handle as the'softap' argument, you can initiate the unregistration process.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_enabled_cb()

int softap_unset_passphrase_changed_cb ( softap_h softap )

Unsets the callback function, which is called when the passphrase of SoftAP is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_passphrase_changed_cb()

int softap_unset_security_type_changed_cb ( softap_h softap )

Unsets the callback function, which is called when the security type of SoftAP is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

Returns:: 0 on success, otherwise negative error value

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_security_type_changed_cb()

int softap_unset_ssid_visibility_changed_cb ( softap_h softap )

Unsets the callback function, which is called when the visibility of SSID is changed.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/softap

Parameters:

[in] softap The SoftAP handle

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

Return values:

SOFTAP_ERROR_NONE	Successful
SOFTAP_ERROR_INVALID_PARAMETER	Invalid parameter
SOFTAP_ERROR_NOT_SUPPORTED	API is not supported
SOFTAP_ERROR_PERMISSION_DENIED	Permission denied

See also:: softap_set_ssid_visibility_changed_cb()

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation