/**
* @class Registry
- * @brief This class provides a mechanism to access and manipulate registry files.
+ * @brief This class provides methods to access and manipulate registry files.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %Registry class provides a mechanism to access and manipulate registry files.
+ * The %Registry class provides methods to access and manipulate registry files.
*
* For more information on the class features,
* see <a href="../org.tizen.native.appprogramming/html/guide/io/io_namespace.htm">Io Guide</a>.
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
* @param[in] createIfNotExist Set to @c true to create a registry file, @n
* else @c false to open an existing registry file
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified string of a file path is less
- * than or equal to @c 0. @n
- * - The translated overall length of the specified path exceeds the
- * system limitation. @n
- * - The specified path is invalid. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified file path string is less
+ * than or equal to @c 0.
+ * - The overall length of the specified file path exceeds the
+ * system limitation.
+ * - The specified file path is invalid.
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
* @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_END_OF_FILE The file pointer has reached end-of-file.
+ * @exception E_END_OF_FILE The file pointer has reached the end of file.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %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.
* @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.
+ * long openMode, long option) method with ::REG_OPEN_READ_ONLY as value for the open mode flag.
* @endcond
*/
result Construct(const Tizen::Base::String& regPath, bool createIfNotExist);
*
* @return An error code
* @param[in] regPath The path of the registry file to open or create
- * @param[in] openMode An open mode flag @n
+ * @param[in] openMode The flag specifying the file opening mode @n
* Currently, the following flags can be used in combination with
* the logical OR operator: @n
* (1) REG_OPEN_READ_ONLY @n
* (2) REG_OPEN_READ_WRITE @n
* (3) REG_OPEN_READ_WRITE | REG_OPEN_CREATE
- * @param[in] option This argument is reserved for further use @n It is recommended to use @c 0.
+ * @param[in] option This argument is reserved for future use. @n It is recommended to use @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified string of a file path is less
- * than or equal to @c 0. @n
- * - The translated overall length of the specified path exceeds the
- * system limitation. @n
- * - The specified path is invalid. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified file path string is less
+ * than or equal to @c 0.
+ * - The overall length of the specified file path exceeds the
+ * system limitation.
+ * - The specified file path is invalid.
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_END_OF_FILE The file pointer has reached end-of-file.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_END_OF_FILE The file pointer has reached the end of file.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %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.
/**
* Initializes this instance of %Registry with the specified parameters. @n
- * This method opens an existing registry file or creates a new one according to the specified file opening mode.
- * And this method loads data of the registry file to system memory and flushes the data to the storage when this instance
+ * This method opens an existing registry file or creates a new one according to the specified file opening mode,
+ * loads the data of the registry file to system memory, and flushes the data to the storage when this instance
* is released or Registry::Flush() is called.
*
* @since 2.0
* - a : Open for writing. The registry file is created if it does not exist.
* - a+: Open for writing and reading. The registry file is created if it does not exist.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The overall length of the specified @c regPath is equal to @c 0 or
- * exceeds system limitations. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified file path string is less than or equal to @c 0.
+ * - The overall length of the specified file path exceeds the system limitation.
* - The combination of the specified @c pOpenMode is not allowed. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified @c regPath cannot be found.
- * @exception E_INVALID_FORMAT Either of the following conditions has occurred: @n
+ * @exception E_INVALID_FORMAT Either of the following conditions has occurred:
* - The section or entry name of the registry file includes one of the following characters:
* '\0', '\n', '#' and '='.
* - The entry value of the registry file includes one of the following characters:
* '\0' and '\n'.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %File corruption is detected.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
/**
* Initializes this instance of %Registry with the specified parameters. @n
- * This method opens an existing secure registry file or creates a new one according to the specified file opening mode.
- * And this method loads data of the secure registry file to system memory and flushes the data to the storage when this instance
+ * This method opens an existing secure registry file or creates a new one according to the specified file opening mode,
+ * loads the data of the secure registry file to system memory and flushes the data to the storage when this instance
* is released or Registry::Flush() is called.
* The contents written to the secure registry file is automatically encrypted and the contents read from the secure registry
* file is automatically decrypted by the platform. @n
- * Applications using this method can access the same secure registry files that are created by other applications with the
- * identical key value in same device. However, the secure registry files created by this method cannot be accessed in other devices.
+ * Applications that use this method can access the secure registry files that are created by other applications with
+ * an identical key value in the same device. However, the secure registry files created by this method cannot be accessed in other devices.
*
* @since 2.0
*
* otherwise it is truncated to zero length.
* - a : Open for writing. The registry file is created if it does not exist.
* - a+: Open for writing and reading. The registry file is created if it does not exist.
- * @param[in] secretKey A key used to encrypt data of a registry file or decrypt a secure registry file @n
- * If a secure registry file is created with a specific key value,
- * other applications can access the same secure registry file with the identical key value.
+ * @param[in] secretKey The key to encrypt the data of the registry file or to decrypt the secure registry file @n
+ * If the secure registry file is created with a specific key value,
+ * other applications can access the secure registry file with an identical key value.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The overall length of the specified path is equal to @c 0 or
* exceeds system limitations.
- * - The combination of the specified @c pOpenMode is not allowed. @n
+ * - The combination of the specified @c pOpenMode is not allowed.
* - The specified @c secretKey is incorrect or the secure registry file is corrupted.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified @c regPath cannot be found.
- * @exception E_INVALID_FORMAT Either of the following conditions has occurred: @n
+ * @exception E_INVALID_FORMAT Either of the following conditions has occurred:
* - The section or entry name of the registry file includes one of the following characters:
* '\0', '\n', '#' and '='.
* - The entry value of the registry file includes one of the following characters:
* '\0' and '\n'.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
- * - %File corruption is detected. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption is detected.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result Construct(const Tizen::Base::String& regPath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey);
/**
- * Flushes the current contents of a registry in memory. @n
- * If the secure mode is set to be @c true, the contents of the registry are automatically encrypted
+ * Flushes the current contents of the registry in memory. @n
+ * If the secure mode is set, the contents of the registry are automatically encrypted
* and saved by the platform.
*
* @since 2.0
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
- * - %File corruption is detected. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption is detected.
*/
result Flush(void);
/**
- * Creates the specified section then adds it into the registry.
+ * Creates the specified section and adds it to the registry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified string for a section name is less than
- * or equal to @c 0.
- * @exception E_SECTION_ALREADY_EXIST A section with the specified name already exists.
+ * @exception E_INVALID_ARG The length of the specified string for a section name is less than or equal to @c 0.
+ * @exception E_SECTION_ALREADY_EXIST The section with the specified name already exists.
*/
result AddSection(const Tizen::Base::String& sectionName);
/**
- * Removes the section from %Registry.
+ * Removes the section from the registry.
*
* @since 2.0
*
* @return An error code
- * @param[in] sectionName The section name to remove
+ * @param[in] sectionName The name of the section to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified string for a section is less than
- * or equal to @c 0.
+ * @exception E_INVALID_ARG The length of the specified string for a section is less than or equal to @c 0.
* @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
*/
result RemoveSection(const Tizen::Base::String& sectionName);
/**
- * Gets all section names in the registry.
+ * Gets all the section names in the registry.
*
* @since 2.0
*
- * @return A list of section names @n
+ * @return The list of all section names in the registry @n
* If this method fails, @c null value is returned. @n
- * The specific error code can be accessed using the GetLastResult() method. @n
- * When there are no sections at all, the method returns an empty list instance. @n
+ * When there are no sections, the method returns an empty list instance. @n
* Use the Tizen::Base::Collection::ICollection::GetCount() method to check the number of elements in the list.
* @exception E_SUCCESS The method is successful.
- * @remarks Do not forget to delete not only the returned IList instance, but also its
- * contents by invoking IList::RemoveAll(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Do not forget to delete not only the returned Tizen::Base::Collection::IList instance, but also its contents by invoking IList::RemoveAll().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllSectionNamesN(void) const;
/**
- * Gets all entry names in the specified section of the registry.
+ * Gets all the entry names in the specified section of the registry.
*
* @since 2.0
*
- * @return A list of entry names @n
+ * @return The list of entry names @n
* If this method fails, @c null value is returned. @n
- * When there are no entries at all, the method returns an empty list instance. @n
+ * When there are no entries, the method returns an empty list instance. @n
* Use the Tizen::Base::Collection::ICollection::GetCount() method to check the number of element in the list.
* @param[in] sectionName The section name
* @exception E_SUCCESS The method is successful.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
* @exception E_IO A system error has occurred.
- * @remarks Do not forget to delete not only the returned IList instance, but also its
- * contents by invoking IList::RemoveAll(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Do not forget to delete not only the returned Tizen::Base::Collection::IList instance, but also its contents by invoking IList::RemoveAll().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllEntryNamesN(const Tizen::Base::String& sectionName) const;
/**
- * Adds the name-value pair of type integer as an entry of the specific section.
+ * Adds the name and integer value as an entry of the specific section.
*
* @since 2.0
*
* @param[in] entryName The entry name
* @param[in] value The @c int value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
* @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, int value);
/**
- * Adds the name-value pair of type double as an entry of the specific section.
+ * Adds the name and double value as an entry of the specific section.
*
* @since 2.0
*
* @param[in] entryName The entry name
* @param[in] value The @c double value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in 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.
+ * @remarks This method converts the specified double type @c value to string value using the "%lg" format specifier. @n
+ * It does not depend on the system locale.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double value);
/**
- * Adds the name-value pair of type float as an entry of the specific section.
+ * Adds the name and float value as an entry of the specific section.
*
* @since 2.0
*
* @param[in] entryName The entry name
* @param[in] value The @c float value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in 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.
+ * @remarks This method converts the specified float type @c value to string value using the "%g" format specifier. @n
+ * It does not depend on the system locale.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float value);
/**
- * Adds the name-value pair of type String as an entry of the specific section.
+ * Adds the name and String value as an entry of the specific section.
*
* @since 2.0
*
* @param[in] entryName The entry name
* @param[in] value The String value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0.
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
* @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::String& value);
/**
- * Adds the name-value pair of type UuId as an entry for the specified section.
+ * Adds the name and UuId value as an entry for the specified section.
*
* @since 2.0
*
* @param[in] entryName The entry name
* @param[in] value The UuId value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
* @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section.
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::UuId& value);
/**
- * Adds the name-value pair of type ByteBuffer as an entry for the specified section.
+ * Adds the name and ByteBuffer value as an entry for the specified section.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
* @param[in] entryName The entry name
- * @param[in] value The @c ByteBuffer value @n
+ * @param[in] value The ByteBuffer value @n
* Note that, it should be constructed before being passed to the method.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
* @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section.
- * @remarks Note that all the contents of @c ByteBuffer are saved as an entry value.
- * That is, byte data from @c 0 up to the buffer limit is saved.
+ * @remarks All the contents of @c ByteBuffer are saved as an entry value. That is, byte data from @c 0 up to the buffer limit is saved.
* @see Tizen::Base::ByteBuffer
*/
result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::ByteBuffer& value);
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The name of entry where its value will be fetched
+ * @param[in] entryName The entry name to get the value
* @param[out] retVal The return value obtained from the registry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @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).
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @exception E_PARSING_FAILED Either of the following conditions has occurred:
+ * - The method has failed to parse the encoded entry value string.
+ * - The specified data type of the value and the data type of the retrieved value are different.
+ * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n
+ * If the value is retrieved using the ::REGTYPE_STRING type,
+ * an empty string is returned even if no value is assigned.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, int& retVal) const;
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The name of entry where its value will be fetched
+ * @param[in] entryName The entry name to get the value
* @param[out] retVal The return value obtained from the registry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @exception E_PARSING_FAILED Either of the following conditions has occurred:
+ * - The method has failed to parse the encoded entry value string.
+ * - The specified data type of the value and the data type of the retrieved value are different.
+ * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n
+ * 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 the system locale.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double& retVal) const;
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The name of entry where its value will be fetched
+ * @param[in] entryName The entry name to get the value
* @param[out] retVal The return value obtained from the registry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @exception E_PARSING_FAILED Either of the following conditions has occurred:
+ * - The method has failed to parse the encoded entry value string.
+ * - The specified data type of the value and the data type of the retrieved value are different.
+ * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n
+ * 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 the system locale.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float& retVal) const;
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The name of entry where its value will be fetched
+ * @param[in] entryName The entry name to get the value
* @param[out] retVal The return value obtained from the registry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @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).
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @exception E_PARSING_FAILED Either of the following conditions has occurred:
+ * - The method has failed to parse the encoded entry value string.
+ * - The specified data type of the value and the data type of the retrieved value are different.
+ * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n
+ * If the value is retrieved using the ::REGTYPE_STRING type,
+ * an empty string is returned even if no value is assigned.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, Tizen::Base::String& retVal) const;
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The name of entry where its value will be fetched
+ * @param[in] entryName The entry name to get the value
* @param[out] retVal The return value obtained from the registry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @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).
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @exception E_PARSING_FAILED Either of the following conditions has occurred:
+ * - The method has failed to parse the encoded entry value string.
+ * - The specified data type of the value and the data type of the retrieved value are different.
+ * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n
+ * If the value is retrieved using the ::REGTYPE_STRING type,
+ * an empty string is returned even if no value is assigned.
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, Tizen::Base::UuId& retVal) const;
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The name of entry where its value will be fetched
+ * @param[in] entryName The entry name to get
* @param[out] retVal The return value obtained from the registry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @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 The ByteBuffer should be constructed before passing it to the method.
- * That is, the size of the binary data to be fetched should be decided beforehand.
- * When the %ByteBuffer capacity is less than the actual binary data stored in the registry,
- * this method reads the data as much as the %ByteBuffer capacity. The position of the %ByteBuffer and
- * limit are not changed. When the %ByteBuffer capacity is greater than the actual data size,
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @exception E_PARSING_FAILED Either of the following conditions has occurred:
+ * - The method has failed to parse the encoded entry value string.
+ * - The specified data type of the value and the data type of the retrieved value are different.
+ * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n
+ * If the value is retrieved using the ::REGTYPE_STRING type,
+ * an empty string is returned even if no value is assigned.
+ * @remarks Decide the size of the byte data to be fecthed and construct the Tizen::Base::ByteBuffer before passing it to the method. @n
+ * When the %Tizen::Base::ByteBuffer capacity is less than the actual binary data stored in the registry,
+ * this method reads data that fits the %Tizen::Base::ByteBuffer capacity. The position of the %Tizen::Base::ByteBuffer and
+ * limit are not changed. @n
+ * When the %Tizen::Base::ByteBuffer capacity is greater than the actual data size,
* the method reads the whole data and adjusts the limit of the buffer accordingly.
* @see Tizen::Base::ByteBuffer
*/
result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, Tizen::Base::ByteBuffer& retVal) const;
/**
- * Modifies the value of the specified entry using the specified @c int value.
+ * Sets the @c int value for the specified entry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The entry name to modify
+ * @param[in] entryName The entry name to set the value
* @param[in] newValue The @c int value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @remarks This method will not set the specified value as an entry of the specific section
+ * if no entry with the specified name exists. @n
+ * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, int newValue);
/**
- * Modifies the value of the specified entry using the specified @c double value.
+ * Sets the @c double value for the specified entry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The entry name to modify
+ * @param[in] entryName The entry name to set the value
* @param[in] newValue The @c double value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @remarks
+ * - This method will not set the specified value as an entry of the specific section
+ * if no entry with the specified name exists. @n
+ * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
+ * - This method converts the specified double type @c newValue to string value using the "%lg" format specifier. @n
+ * It does not depend on the system locale.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double newValue);
/**
- * Modifies the value of the specified entry using the specified @c float value.
+ * Sets the @c float value for the specified entry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The entry name to modify
+ * @param[in] entryName The entry name to set the value
* @param[in] newValue The @c float value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @remarks
+ * - This method will not set the specified value as an entry of the specific section
+ * if no entry with the specified name exists. @n
+ * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
+ * - This method converts the specified float type @c newValue to string value using the "%g" format specifier. @n
+ * It does not depend on the system locale.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float newValue);
/**
- * Modifies the value of the specified entry using the specified String value.
+ * Sets the String value for the specified entry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The entry name to modify
+ * @param[in] entryName The entry name to set the value
* @param[in] newValue The String value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0.
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @remarks This method will not set the specified value as an entry of the specific section
+ * if no entry with the specified name exists. @n
+ * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::String& newValue);
/**
- * Modifies the value of the specified entry using the specified UuID value.
+ * Sets the UuId value for the specified entry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The entry name to modify
+ * @param[in] entryName The entry name to set the value
* @param[in] newValue The UuId value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @remarks This method will not set the specified value as an entry of the specific section
+ * if no entry with the specified name exists. @n
+ * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::UuId& newValue);
/**
- * Modifies the value of the specified entry using the specified ByteBuffer value.
+ * Sets the ByteBuffer value for the specified entry.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionName The section name
- * @param[in] entryName The entry name to modify
+ * @param[in] entryName The entry name to set the value
* @param[in] newValue The @c ByteBuffer value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either the length of the specified string for a section
- * or an entry is less than or equal to @c 0,
- * or a @c null value is passed. @n
- * Note that, it is also possible that the data inside a registry instance is
- * corrupted due to its usage in a multi-threaded environment without
- * synchronization.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
- * @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.
+ * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
+ * @remarks This method will not set the specified value as an entry of the specific section
+ * if no entry with the specified name exists. @n
+ * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry.
* @see AddValue()
*/
result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::ByteBuffer& newValue);
/**
- * Removes the name-value pair entry from specific section.
+ * Removes the name-value pair entry from specified section.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified string for a section or entry is less
* than or equal to @c 0.
- * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry.
- * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry.
+ * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry.
+ * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry.
*/
result RemoveValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName);
*
* @since 2.1
*
- * @return The pointer to %FileLock instance, @n
- * else @c null pointer in case of failure
- * @param[in] lockType The type of file lock to be created
+ * @return The pointer to the FileLock instance, @n
+ * else @c null pointer in case of failure
+ * @param[in] lockType The file lock type to be created
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c lockType is invalid.
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current
- * file is not open for reading. @n
- * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current
- * file is not open for writing. @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current
+ * file is not open for reading.
+ * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current
+ * file is not open for writing.
* @exception E_WOULD_DEADLOCK The method would cause a deadlock. @n
- * The lock is blocked by a lock from another process, and putting the
- * calling process to sleep to wait for that lock to become free would
- * cause a deadlock.
- * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations.
+ * The lock is blocked by a lock from another process, and putting the
+ * calling process to sleep to wait for that lock to become free would
+ * cause a deadlock.
+ * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations.
* @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.
+ * @remarks
+ * - The FileLock instance is invalid if the associated %File instance is deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
FileLock* LockN(FileLockType lockType);
/**
* Tries to acquire the file lock on the current opened whole file.
- * If the file lock is already acquired by another process, E_OBJECT_LOCKED is returned.
+ * If the file lock is already acquired by another process, @c E_OBJECT_LOCKED is returned.
*
* @since 2.1
*
- * @return The pointer to %FileLock instance, @n
- * else @c null pointer in case of failure
+ * @return The pointer to the FileLock instance, @n
+ * else @c null pointer in case of failure
* @param[in] lockType The type of file lock to be created
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c lockType is invalid.
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current
- * file is not open for reading. @n
- * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current
- * file is not open for writing. @n
- * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: @n
- * - The file lock is already held by another process. @n
- * - The file to be locked has been memory-mapped by another process.
- * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current
+ * file is not open for reading.
+ * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current
+ * file is not open for writing.
+ * @exception E_OBJECT_LOCKED Either of the following conditions has occurred:
+ * - The file lock is already held by another process.
+ * - The file to be locked has been memory-mapped by another process.
+ * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations.
* @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.
+ * @remarks
+ * - The FileLock instance is invalid if the associated %File instance is deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
FileLock* TryToLockN(FileLockType lockType);
* @return An error code
* @param[in] regPath The path of the registry file to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The length of the specified string of a file path is less
- * than or equal to @c 0. @n
- * - The translated overall length of the specified path exceeds the
- * system limitation. @n
- * - The specified path is invalid. @n
+ * than or equal to @c 0.
+ * - The overall length of the specified path exceeds the
+ * system limitation.
+ * - The specified path is invalid.
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %File corruption is detected.
*/
static result Remove(const Tizen::Base::String& regPath);
* @return An error code
* @param[in] plainRegPath The normal (non-encrypted) registry file path
* @param[in] secureRegPath The secure (encrypted) registry file path to create
- * @param[in] key A key that encrypts a secure registry file @n
- * If the secure registry file is converted with a specific key value,
- * applications can access the same secure registry file with the identical key value.
+ * @param[in] key The key that encrypts the secure registry file @n
+ * If the secure registry file is converted with the specific key value,
+ * applications can access the same secure registry file with an identical key value.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The length of the specified string of a file path is less
- * than or equal to @c 0. @n
- * - The translated overall length of the specified path exceeds the
- * system limitation. @n
- * - The specified path is invalid. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * than or equal to @c 0.
+ * - The overall length of the specified path exceeds the
+ * system limitation.
+ * - The specified path is invalid.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
* @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.
* @exception E_STORAGE_FULL The disk space is full.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
- * - %File corruption is detected. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
+ * - %File corruption is detected.
* - The number of opened files has exceeded the maximum limit.
*/
static result ConvertToSecureRegistry(const Tizen::Base::String& plainRegPath, const Tizen::Base::String& secureRegPath, const Tizen::Base::ByteBuffer& key);
projects / platform / framework / native / appfw.git / blobdiff