|
Tizen Native API
5.0
|
The Configuration API provides functions for managing the configuration of Wi-Fi.
#include <wifi.h>
The Configuration API provides functions for managing the configuration of Wi-Fi. You can manage the configuration information using the functions.
This API is related with the following features:
Functions | |
| int | wifi_config_create (const char *name, const char *passphrase, wifi_security_type_e security_type, wifi_config_h *config) TIZEN_DEPRECATED_API |
| Gets access point configuration handle. | |
| int | wifi_config_clone (wifi_config_h origin, wifi_config_h *cloned_config) TIZEN_DEPRECATED_API |
| Clones the access point configuration handle. | |
| int | wifi_config_destroy (wifi_config_h config) TIZEN_DEPRECATED_API |
| Destroys the access point configuration handle. | |
| int | wifi_config_save_configuration (wifi_config_h config) TIZEN_DEPRECATED_API |
| Saves Wi-Fi configuration of access point. | |
| int | wifi_config_remove (wifi_config_h config) TIZEN_DEPRECATED_API |
| Removes Wi-Fi configuration of access point. | |
| int | wifi_config_foreach_configuration (wifi_config_list_cb callback, void *user_data) TIZEN_DEPRECATED_API |
| Gets the result of access point configurations repeatedly. | |
| int | wifi_config_get_name (wifi_config_h config, char **name) TIZEN_DEPRECATED_API |
| Gets the name of access point from configuration. | |
| int | wifi_config_get_security_type (wifi_config_h config, wifi_security_type_e *security_type) TIZEN_DEPRECATED_API |
| Gets the security type of access point from configuration. | |
| int | wifi_config_set_proxy_address (wifi_config_h config, wifi_address_family_e address_family, const char *proxy_address) TIZEN_DEPRECATED_API |
| Sets access point proxy address configuration. | |
| int | wifi_config_get_proxy_address (wifi_config_h config, wifi_address_family_e *address_family, char **proxy_address) TIZEN_DEPRECATED_API |
| Gets the proxy address of access point from configuration. | |
| int | wifi_config_set_hidden_ap_property (wifi_config_h config, bool is_hidden) TIZEN_DEPRECATED_API |
| Sets the hidden property of access point from the configuration. | |
| int | wifi_config_get_hidden_ap_property (wifi_config_h config, bool *is_hidden) TIZEN_DEPRECATED_API |
| Gets the hidden property of access point from the configuration. | |
| int | wifi_config_get_eap_anonymous_identity (wifi_config_h config, char **anonymous_identity) TIZEN_DEPRECATED_API |
| Gets access point anonymous identity from configuration. | |
| int | wifi_config_set_eap_anonymous_identity (wifi_config_h config, const char *anonymous_identity) TIZEN_DEPRECATED_API |
| Sets access point anonymous identity to configuration. | |
| int | wifi_config_get_eap_ca_cert_file (wifi_config_h config, char **ca_cert) TIZEN_DEPRECATED_API |
| Gets access point cacert file from configuration. | |
| int | wifi_config_set_eap_ca_cert_file (wifi_config_h config, const char *ca_cert) TIZEN_DEPRECATED_API |
| Sets access point cacert file to configuration. | |
| int | wifi_config_get_eap_client_cert_file (wifi_config_h config, char **client_cert) TIZEN_DEPRECATED_API |
| Gets access point client cert file from configuration. | |
| int | wifi_config_set_eap_client_cert_file (wifi_config_h config, const char *private_key, const char *client_cert) TIZEN_DEPRECATED_API |
| Sets access point client cert file to configuration. | |
| int | wifi_config_get_eap_identity (wifi_config_h config, char **identity) TIZEN_DEPRECATED_API |
| Gets access point identity from configuration. | |
| int | wifi_config_set_eap_identity (wifi_config_h config, const char *identity) TIZEN_DEPRECATED_API |
| Sets access point identity to configuration. | |
| int | wifi_config_get_eap_type (wifi_config_h config, wifi_eap_type_e *eap_type) TIZEN_DEPRECATED_API |
| Gets access point eap type from configuration. | |
| int | wifi_config_set_eap_type (wifi_config_h config, wifi_eap_type_e eap_type) TIZEN_DEPRECATED_API |
| Sets access point eap type to configuration. | |
| int | wifi_config_get_eap_auth_type (wifi_config_h config, wifi_eap_auth_type_e *eap_auth_type) TIZEN_DEPRECATED_API |
| Gets access point eap auth type from configuration. | |
| int | wifi_config_set_eap_auth_type (wifi_config_h config, wifi_eap_auth_type_e eap_auth_type) TIZEN_DEPRECATED_API |
| Sets access point eap auth type to configuration. | |
| int | wifi_config_get_eap_subject_match (wifi_config_h config, char **subject_match) TIZEN_DEPRECATED_API |
| Gets access point subject match from configuration. | |
| int | wifi_config_set_eap_subject_match (wifi_config_h config, const char *subject_match) TIZEN_DEPRECATED_API |
| Sets access point subject match to configuration. | |
Typedefs | |
| typedef void * | wifi_config_h |
| The Wi-Fi access point configuration handle. | |
| typedef bool(* | wifi_config_list_cb )(const wifi_config_h config, void *user_data) |
| Called when you get the found access point configurations repeatedly. | |
| typedef void* wifi_config_h |
The Wi-Fi access point configuration handle.
| typedef bool(* wifi_config_list_cb)(const wifi_config_h config, void *user_data) |
Called when you get the found access point configurations repeatedly.
| [in] | config | The access point configuration handle |
| [in] | user_data | The user data passed from the request function |
true to continue with the next iteration of the loop, otherwise false to break out of the loop | int wifi_config_clone | ( | wifi_config_h | origin, |
| wifi_config_h * | cloned_config | ||
| ) |
Clones the access point configuration handle.
| [in] | origin | The origin access point configuration handle |
| [out] | cloned_config | The cloned access point configuration handle |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_OUT_OF_MEMORY | Out of memory |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_create | ( | const char * | name, |
| const char * | passphrase, | ||
| wifi_security_type_e | security_type, | ||
| wifi_config_h * | config | ||
| ) |
Gets access point configuration handle.
| [in] | name | The access point name |
| [in] | passphrase | The access point passphrase |
| [in] | security_type | The access point security type |
| [out] | config | The access point configuration handle |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_OUT_OF_MEMORY | Out of memory |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_destroy | ( | wifi_config_h | config | ) |
Destroys the access point configuration handle.
| [in] | config | The access point configuration handle |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_foreach_configuration | ( | wifi_config_list_cb | callback, |
| void * | user_data | ||
| ) |
Gets the result of access point configurations repeatedly.
| [in] | callback | The callback to be called |
| [in] | user_data | The user data passed to the callback function |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission denied |
| WIFI_ERROR_OUT_OF_MEMORY | Out of memory |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_get_eap_anonymous_identity | ( | wifi_config_h | config, |
| char ** | anonymous_identity | ||
| ) |
Gets access point anonymous identity from configuration.
| [in] | config | The access point configuration handle |
| [out] | anonymous_identity | The anonymous identity of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_eap_auth_type | ( | wifi_config_h | config, |
| wifi_eap_auth_type_e * | eap_auth_type | ||
| ) |
Gets access point eap auth type from configuration.
| [in] | config | The access point configuration handle |
| [out] | eap_auth_type | The eap auth type of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_eap_ca_cert_file | ( | wifi_config_h | config, |
| char ** | ca_cert | ||
| ) |
Gets access point cacert file from configuration.
| [in] | config | The access point configuration handle |
| [out] | ca_cert | The certification authority(CA) certificates file of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_eap_client_cert_file | ( | wifi_config_h | config, |
| char ** | client_cert | ||
| ) |
Gets access point client cert file from configuration.
| [in] | config | The access point configuration handle |
| [out] | client_cert | The certification authority(CA) certificates file of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_eap_identity | ( | wifi_config_h | config, |
| char ** | identity | ||
| ) |
Gets access point identity from configuration.
| [in] | config | The access point configuration handle |
| [out] | identity | The identity of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_eap_subject_match | ( | wifi_config_h | config, |
| char ** | subject_match | ||
| ) |
Gets access point subject match from configuration.
| [in] | config | The access point configuration handle |
| [out] | subject_match | The subject match of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_eap_type | ( | wifi_config_h | config, |
| wifi_eap_type_e * | eap_type | ||
| ) |
Gets access point eap type from configuration.
| [in] | config | The access point configuration handle |
| [out] | eap_type | The eap type of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| int wifi_config_get_hidden_ap_property | ( | wifi_config_h | config, |
| bool * | is_hidden | ||
| ) |
Gets the hidden property of access point from the configuration.
| [in] | config | The access point configuration handle |
| [out] | is_hidden | The hidden property of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_get_name | ( | wifi_config_h | config, |
| char ** | name | ||
| ) |
Gets the name of access point from configuration.
| [in] | config | The access point configuration handle |
| [out] | name | The name of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_OUT_OF_MEMORY | Out of memory |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_get_proxy_address | ( | wifi_config_h | config, |
| wifi_address_family_e * | address_family, | ||
| char ** | proxy_address | ||
| ) |
Gets the proxy address of access point from configuration.
| [in] | config | The access point configuration handle |
| [out] | address_family | The address family |
| [out] | proxy_address | The proxy address |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_OUT_OF_MEMORY | Out of memory |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_get_security_type | ( | wifi_config_h | config, |
| wifi_security_type_e * | security_type | ||
| ) |
Gets the security type of access point from configuration.
| [in] | config | The access point configuration handle |
| [out] | security_type | The security type of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_remove | ( | wifi_config_h | config | ) |
Removes Wi-Fi configuration of access point.
| [in] | config | The access point configuration handle |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission denied |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_save_configuration | ( | wifi_config_h | config | ) |
Saves Wi-Fi configuration of access point.
| [in] | config | The access point configuration handle |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission denied |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_set_eap_anonymous_identity | ( | wifi_config_h | config, |
| const char * | anonymous_identity | ||
| ) |
Sets access point anonymous identity to configuration.
| [in] | config | The access point configuration handle |
| [in] | anonymous_identity | The anonymous identity |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_eap_auth_type | ( | wifi_config_h | config, |
| wifi_eap_auth_type_e | eap_auth_type | ||
| ) |
Sets access point eap auth type to configuration.
| [in] | config | The access point configuration handle |
| [in] | eap_auth_type | The eap auth type |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_eap_ca_cert_file | ( | wifi_config_h | config, |
| const char * | ca_cert | ||
| ) |
Sets access point cacert file to configuration.
| [in] | config | The access point configuration handle |
| [in] | ca_cert | The certification authority(CA) certificates file of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_eap_client_cert_file | ( | wifi_config_h | config, |
| const char * | private_key, | ||
| const char * | client_cert | ||
| ) |
Sets access point client cert file to configuration.
| [in] | config | The access point configuration handle |
| [in] | private_key | The private key file |
| [in] | client_cert | The certification authority(CA) certificates file of access point |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_eap_identity | ( | wifi_config_h | config, |
| const char * | identity | ||
| ) |
Sets access point identity to configuration.
| [in] | config | The access point configuration handle |
| [in] | identity | The identity |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_eap_subject_match | ( | wifi_config_h | config, |
| const char * | subject_match | ||
| ) |
Sets access point subject match to configuration.
| [in] | config | The access point configuration handle |
| [in] | subject_match | The subject match |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_eap_type | ( | wifi_config_h | config, |
| wifi_eap_type_e | eap_type | ||
| ) |
Sets access point eap type to configuration.
| [in] | config | The access point configuration handle |
| [in] | eap_type | The eap type |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission Denied |
| int wifi_config_set_hidden_ap_property | ( | wifi_config_h | config, |
| bool | is_hidden | ||
| ) |
Sets the hidden property of access point from the configuration.
| [in] | config | The access point configuration handle |
| [in] | is_hidden | true to enable and false to disable |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission denied |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |
| int wifi_config_set_proxy_address | ( | wifi_config_h | config, |
| wifi_address_family_e | address_family, | ||
| const char * | proxy_address | ||
| ) |
Sets access point proxy address configuration.
| [in] | config | The access point configuration handle |
| [in] | address_family | The address family |
| [in] | proxy_address | The proxy address |
| WIFI_ERROR_NONE | Successful |
| WIFI_ERROR_INVALID_OPERATION | Invalid operation |
| WIFI_ERROR_INVALID_PARAMETER | Invalid parameter |
| WIFI_ERROR_PERMISSION_DENIED | Permission denied |
| WIFI_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED | Not supported address family |
| WIFI_ERROR_NOT_SUPPORTED | Not supported |