//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
virtual ~Registry(void);
/**
- * @if OSPDEPREC
- * @{
+ * @cond OSPDEPREC
* Initializes this instance of %Registry with the specified parameters. @n
* This method loads a registry file in the read-write mode.
*
* @exception E_PARSING_FAILED The method has failed to parse the registry file.
* @remarks To load the registry in read-only mode, use the Registry::Construct(const Tizen::Base::String& regPath,
* long openMode, long option) method with REG_OPEN_READ_ONLY as a value for the open mode flag.
- * @}
- * @endif
+ * @endcond
*/
result Construct(const Tizen::Base::String& regPath, bool createIfNotExist);
/**
- * @if OSPDEPREC
- * @{
+ * @cond OSPDEPREC
* Initializes this instance of %Registry with the specified parameters. @n
* This method loads a registry file in the read-only or the read-write mode.
*
* - %File corruption is detected.
* @exception E_INVALID_FORMAT The input registry file contains '0x00' in the middle of the file.
* @exception E_PARSING_FAILED The method has failed to parse the registry file.
- * @}
- * @endif
+ * @endcond
*/
result Construct(const Tizen::Base::String& regPath, long openMode, long option);
* synchronization.
* @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
* @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section.
+ * @remarks This method converts the specified double type @c value to string value using "%lg" format specifier. @n
+ * Also, it does not depend on system locale.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double value);
* synchronization.
* @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
* @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section.
+ * @remarks This method converts the specified float type @c value to string value using "%g" format specifier. @n
+ * Also, it does not depend on system locale.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float value);
* @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
* @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type.
* @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned).
+ * @remarks This method does not depend on system locale.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double& retVal) const;
* @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
* @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type.
* @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned).
+ * @remarks This method does not depend on system locale.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float& retVal) const;
* @remarks This method will not add a name-value pair as an entry of a specific section
* if no entry with the specified name exists.
* In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
+ * @remarks This method converts the specified double type @c newValue to string value using "%lg" format specifier. @n
+ * Also, it does not depend on system locale.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double newValue);
* @remarks This method will not add a name-value pair as an entry of a specific section
* if no entry with the specified name exists.
* In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
+ * @remarks This method converts the specified float type @c newValue to string value using "%g" format specifier. @n
+ * Also, it does not depend on system locale.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float newValue);
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n
* The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Io::File::FileLockType
*/
FileLock* LockN(FileLockType lockType);
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n
* The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Io::File::FileLockType
*/
FileLock* TryToLockN(FileLockType lockType);