X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSysSettingInfo.h;h=901debd7df07b994f431f97f19cd50f56cdabea3;hb=102d9124a6981de495cb23e8bd98c2de322960fb;hp=db0874c514afe16b410955b01a8c79ea23ac895f;hpb=48ac942873b3e63fd03835872aa2b20dfc38d9cb;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSysSettingInfo.h b/inc/FSysSettingInfo.h index db0874c..901debd 100644 --- a/inc/FSysSettingInfo.h +++ b/inc/FSysSettingInfo.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -36,13 +35,14 @@ namespace Tizen { namespace System /** * @class SettingInfo - * @brief This class provides methods for managing setting information. + * @brief This class provides methods to manage the setting information. * * @since 2.0 * * @final This class is not intended for extension. * - * The %SettingInfo class provides methods to managing the variety user setting elements. Please refer SettingInfo key. + * The %SettingInfo class provides methods to manage the user setting elements. @n + * To get the system information, you must provide the SettingInfo key. * * For more information on the class features, see Settings Information. * @@ -81,188 +81,182 @@ class _OSP_EXPORT_ SettingInfo public: /** - * Gets the specific Tizen::Base::String type setting information based on the specified - * designators (key). + * Gets the Tizen::Base::String type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type setting information based on the specified - * designators (keys). + * Gets the specific integer type setting information for the specified designators (keys). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type integer - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type @c int + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific @c long @c long type setting information based on the specified - * designators (key). + * Gets the @c long @c long type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information + * @return An error code + * @param[in] key The key name of the setting information * @param[out] value The setting information of type @c long @c long - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, long long& value); /** - * Gets the specific double type setting information based on the specified - * designators (key). + * Gets the double type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type double - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type @c double + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific @c bool type setting information based on the specified - * designators (key). + * Gets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** - * Gets the specific UuId type setting information based on the specified - * designators (key). + * Gets the UuId type setting information for the specified designators (key). * * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type UuId - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type UuId + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Checks whether specific designator(key) is supported or not. + * Checks whether specific designator(key) is supported. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the key is supported, @n - * else @c false - * @param[in] key The key name of the setting information + * @return @c true if the key is supported, @n + * else @c false + * @param[in] key The key name of the setting information * */ static bool HasKey(const Tizen::Base::String& key); /** - * Sets the specific @c bool type setting information based on the specified designators (key). + * Sets the specified @c bool type setting information for the specified designators (key). * * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, bool value); /** - * Sets the specific @c int type setting information based on the specified designators (key). + * Sets the specified @c int type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type int - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c int + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, int value); /** * Sets the specific Tizen::Base::String type setting information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, Tizen::Base::String value); @@ -274,12 +268,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code - * @param[in] filePath The file path of the wallpaper - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] filePath The file path of the wallpaper + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetWallpaper(const Tizen::Base::String& filePath); @@ -292,12 +286,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code - * @param[in] filePath The file path of the ringtone - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] filePath The file path of the ringtone + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetRingtone(const Tizen::Base::String& filePath); @@ -309,14 +303,14 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] soundCategory The sound volume category - * @param[in] level The sound volume level of the designated category - * @exception E_SUCCESS The method is successful. + * @param[in] level The sound volume level of the designated category + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG The specified @c soundCategory is invalid. * @exception E_OUT_OF_RANGE The specified @c level is outside the bounds of @c soundCategory. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetVolume(const Tizen::Base::String& soundCategory, int level); @@ -324,109 +318,115 @@ public: * Adds the setting event listener. @n * This listener is called when a setting value is changed. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] listener The setting event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The listener is already added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see RemoveSettingEventListener() + * @return An error code + * @param[in] listener The setting event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_ALREADY_EXIST The listener is already added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see RemoveSettingEventListener() */ static result AddSettingEventListener(ISettingEventListener& listener); /** * Removes the setting event listener. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] listener The setting event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The listener is not added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see AddSettingEventListener() + * @return An error code + * @param[in] listener The setting event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The listener is not added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see AddSettingEventListener() */ static result RemoveSettingEventListener(ISettingEventListener& listener); /** - * Gets the specific @c bool type setting information based on the specified designators (key). + * Gets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel platform - * @privilege %http://tizen.org/privilege/settingmanager.read - * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @privilege %http://tizen.org/privilege/settingmanager.read @n + * (%http://tizen.org/privilege/systemsetting.read is deprecated.) + * + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueForPrivilegedKey(const Tizen::Base::String& key, bool& value); /** - * Sets the specific @c bool type setting information based on the specified designators (key). + * Sets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel platform - * @privilege %http://tizen.org/privilege/settingmanager.write - * - * @return An error code - * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @privilege %http://tizen.org/privilege/settingmanager.write @n + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * + * @return An error code + * @param[in] key The key name of the setting information + * @param[in] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid value. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueForPrivilegedKey(const Tizen::Base::String& key, bool value); /** - * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously. + * Sets the @c bool type setting information for the specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * @privlevel platform - * @privilege %http://tizen.org/privilege/settingmanager.write + * @privilege %http://tizen.org/privilege/settingmanager.write @n + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @param[in] listener The result listener. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device. - * @exception E_IN_PROGRESS The specified key is under processing or invalid state. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device. + * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state. + * @exception E_SYSTEM Either of the following conditions has occured: + * - The method cannot proceed due to a severe system error. + * - Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is + * activated. */ static result SetValueAsyncForPrivilegedKey(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener); /** - * Sets the specific @c bool type sett * @exception E_IN_PROGRESS The specified key is under processing or invalid state.ing information based on the specified designators (key) asynchronously. + * Sets the @c bool type setting information for the specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @param[in] listener The result listener. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device. - * @exception E_IN_PROGRESS The specified key is under processing or invalid state. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid value. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device. + * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueAsync(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener); @@ -437,49 +437,52 @@ public: * @since 2.0 * * @privlevel platform - * @privilege %http://tizen.org/privilege/settingmanager.write + * @privilege %http://tizen.org/privilege/settingmanager.write @n + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @param[in] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueForPrivilegedKey(const Tizen::Base::String& key, Tizen::Base::String value); /** - * Resets current device. @n + * Resets the current device to the default factory settings. @n * All data is removed and device is initialized. * - * @since 2.0 + * @since 2.0 * * @privlevel platform - * @privilege %http://tizen.org/privilege/settingmanager.write + * @privilege %http://tizen.org/privilege/settingmanager.write @n + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result ResetToFactoryDefault(void); /** * @if OSPCOMPAT * @if OSPDEPREC - * Sets the setting event listener. + * Sets the specified setting event listener. * - * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is recommended to use AddSettingEventListener() and RemoveSettingEventListener(). - * @since 2.0 + * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is + * recommended to use AddSettingEventListener() and RemoveSettingEventListener(). + * @since 2.0 * - * @return An error code + * @return An error code * @param[in] pListener The setting event listener * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called. + * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called. * @endif * @endif */