* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FIo.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* The %Io namespace allows applications to input/output data to/from file systems and other programs and process it.
* Thus, the %Io namespace is an interface between the system and the application.
- * The %Io namespace provides classes and methods for managing files, directories, registries, databases, channels, and serial port communication.
- * @n
+ * The %Io namespace provides classes and methods for managing files, directories, registries, databases, channels,
+ * and serial port communication.
+ *
* For more information on the %Io namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/io/io_namespace.htm">Io Guide</a>.
*
* The following diagram illustrates the relationships between the classes belonging to the %Io namespace.
*
* @since 2.0
*
- * @return A pointer to the %ClientChannel instance, @n
+ * @return The pointer to the %ClientChannel instance, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*
* @since 2.0
*
- * @return A pointer to the %ClientChannel instance, @n
+ * @return The pointer to the %ClientChannel instance, @n
* else @c null if it fails
* @param[in] channelName The channel name
* @exception E_SUCCESS The method is successful.
*
* @since 2.0
*
- * @return An error code
- * @param[in] serverChannelId The server channel ID which can be either application ID or appicationID.ChannelName
- * @param[in] pArgs A pointer to an argument list of type String
- * @param[out] reqId The request ID
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The server channel is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @return An error code
+ * @param[in] serverChannelId The server channel ID which can be either application ID or appicationID.ChannelName
+ * @param[in] pArgs A pointer to an argument list of type String
+ * @param[out] reqId The request ID
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The server channel is not found.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SendRequest(const Tizen::Base::String& serverChannelId, const Tizen::Base::Collection::IList* pArgs, RequestId& reqId);
/**
* @file FIoDataRow.h
-* @brief This is the header file for the %DataRow class.
+* @brief This is the header file for the %DataRow class.
*
* This header file contains the declarations of the %DataRow class.
*/
virtual ~DataRow(void);
/**
- * Sets a Tizen::Base::ByteBuffer value to the column whose index is specified.
+ * Sets a Tizen::Base::ByteBuffer value to the column with the specified index.
*
* @since 2.1
*
- * @return An error code
+ * @return An error code
* @param[in] columnIndex The index of the column whose value is set @n
- * The column index starts from 0.
+ * The column index starts from @c 0.
* @param[in] pValue The value to set @n
- * The specified @c pValue is a pointer to user-provided Tizen::Base::ByteBuffer type buffer.
+ * The specified @c pValue is a pointer to user-provided Tizen::Base::ByteBuffer type buffer.
* @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 specified @c columnIndex is out of range.
* - The specified @c pValue is @c null.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. @n
- * The platform will take the ownership of @c pValue after calling this method.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @remarks
+ * - This method performs a shallow copy. It copies just the pointer and not the element itself.
+ * - The platform will take the ownership of @c pValue after calling this method.
*/
result SetBlobAt(int columnIndex, Tizen::Base::ByteBuffer* pValue);
/**
- * Sets a Tizen::Base::DateTime value to the column whose index is specified.
+ * Sets a Tizen::Base::DateTime value to the column with the specified index.
*
* @since 2.1
*
* @param[in] value The value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @remarks Tizen::Io::DbColumnType of the specified @c value is DB_COLUMNTYPE_TEXT.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @remarks Tizen::Io::DbColumnType of the specified @c value is ::DB_COLUMNTYPE_TEXT.
*/
result SetDateTimeAt(int columnIndex, const Tizen::Base::DateTime& value);
/**
- * Sets a @c double value to the column whose index is specified.
+ * Sets a @c double value to the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is set @n
- * The column index starts from 0.
- * @param[in] value The value to set
+ * @return An error code
+ * @param[in] columnIndex The index of the column whose value is set @n
+ * The column index starts from @c 0.
+ * @param[in] value The value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
result SetDoubleAt(int columnIndex, double value);
/**
- * Sets an @c int value to the column whose index is specified.
+ * Sets an @c int value to the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is set @n
- * The column index starts from 0.
- * @param[in] value The value to set
+ * @return An error code
+ * @param[in] columnIndex The index of the column whose value is set @n
+ * The column index starts from @c 0.
+ * @param[in] value The value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the operation do not match.
*/
result SetIntAt(int columnIndex, int value);
/**
- * Sets a @c long @c long value to the column whose index is specified.
+ * Sets a @c long @c long value to the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is set @n
- * The column index starts from 0.
- * @param[in] value The value to set
+ * @return An error code
+ * @param[in] columnIndex The index of the column whose value is set @n
+ * The column index starts from @c 0.
+ * @param[in] value The value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
result SetInt64At(int columnIndex, long long value);
/**
- * Sets a Tizen::Base::String value to the column whose index is specified.
+ * Sets a Tizen::Base::String value to the column with the specified index.
*
* @since 2.1
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is set @n
- * The column index starts from 0.
- * @param[in] value The value to set
+ * @param[in] columnIndex The index of the column whose value is set @n
+ * The column index starts from @c 0.
+ * @param[in] value The value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
result SetStringAt(int columnIndex, const Tizen::Base::String& value);
virtual ~DataSet(void);
/**
- * Creates in-memory table.
+ * Creates an in-memory table.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @param[in] columnNames The list of column names to create @n
- * The object type in the specified list should be String.
+ * The object type in the specified list should be String.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c columnNames has no element.
*/
*
* @return A pointer to the DataRow instance, @n
* else @c null if the memory is insufficient
- * @remarks The column type is decided by the type of each element inserted in first row.
- * If a specific column element on the first row is not inserted, then the column's type is @c DB_COLUMNTYPE_NULL
- * In that case, when a new column element is added later,
- * then the column's type will be changed according to the new element.
+ * @remarks The column type is decided by the type of each element inserted in first row. @n
+ * If a specific column element on the first row is not inserted, then the column's type is ::DB_COLUMNTYPE_NULL. @n
+ * In that case, when a new column element is added later, then the column's type will be changed according to the new element.
*/
DataRow* CreateDataRowN(void);
/**
- * Gets a table enumerator.
+ * Gets the table enumerator.
*
* @since 2.1
*
virtual bool Equals(const Tizen::Base::Object& obj) const;
/**
- * Gets the hash value of a current instance.
+ * Gets the hash value of the current instance.
*
* @since 2.1
*
/**
* Moves the enumerator to the next position.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_OUT_OF_RANGE The enumerator has reached out of the data set.
* @exception E_OBJECT_LOCKED The DataSet instance is locked.
* @exception E_INVALID_FORMAT The in-memory data is malformed.
- * @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.
- * @remarks After getting this %DataSetEnumerator instance,
- * if this method is called first, the cursor goes to the first position.
- * @see Tizen::Io::DataSetEnumerator::MovePrevious()
- * @see Tizen::Io::DataSetEnumerator::MoveFirst()
- * @see Tizen::Io::DataSetEnumerator::MoveLast()
+ * @remarks After getting this %DataSetEnumerator instance,
+ * if this method is called first, the cursor goes to the first position.
+ * @see Tizen::Io::DataSetEnumerator::MovePrevious()
+ * @see Tizen::Io::DataSetEnumerator::MoveFirst()
+ * @see Tizen::Io::DataSetEnumerator::MoveLast()
*/
virtual result MoveNext(void);
/**
* Moves the enumerator to the previous position.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_OUT_OF_RANGE The enumerator has reached out of the data set.
* @exception E_OBJECT_LOCKED The DataSet instance is locked.
* @exception E_INVALID_FORMAT The in-memory data is malformed.
- * @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.
- * @see Tizen::Io::DataSetEnumerator::MoveNext()
- * @see Tizen::Io::DataSetEnumerator::MoveFirst()
- * @see Tizen::Io::DataSetEnumerator::MoveLast()
+ * @see Tizen::Io::DataSetEnumerator::MoveNext()
+ * @see Tizen::Io::DataSetEnumerator::MoveFirst()
+ * @see Tizen::Io::DataSetEnumerator::MoveLast()
*/
virtual result MovePrevious(void);
/**
* Moves the enumerator to the first position.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_OBJECT_LOCKED The DataSet instance is locked.
+ * @exception E_OBJECT_LOCKED The DataSet instance is locked.
* @exception E_INVALID_FORMAT The in-memory data is malformed.
- * @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.
- * @see Tizen:Io::DataSetEnumerator::MoveNext()
- * @see Tizen:Io::DataSetEnumerator::MovePrevious()
- * @see Tizen:Io::DataSetEnumerator::MoveLast()
+ * @see Tizen:Io::DataSetEnumerator::MoveNext()
+ * @see Tizen:Io::DataSetEnumerator::MovePrevious()
+ * @see Tizen:Io::DataSetEnumerator::MoveLast()
*/
virtual result MoveFirst(void);
/**
* Moves the enumerator to the last position.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_OBJECT_LOCKED The DataSet instance is locked.
+ * @exception E_OBJECT_LOCKED The DataSet instance is locked.
* @exception E_INVALID_FORMAT The in-memory data is malformed.
- * @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.
- * @see Tizen:Io::DataSetEnumerator::MoveNext()
- * @see Tizen:Io::DataSetEnumerator::MovePrevious()
- * @see Tizen:Io::DataSetEnumerator::MoveFirst()
+ * @see Tizen:Io::DataSetEnumerator::MoveNext()
+ * @see Tizen:Io::DataSetEnumerator::MovePrevious()
+ * @see Tizen:Io::DataSetEnumerator::MoveFirst()
*/
virtual result MoveLast(void);
/**
- * Resets the calling %DataSetEnumerator instance back to its initial state.
+ * Resets the current %DataSetEnumerator instance to its initial state.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_OBJECT_LOCKED The DataSet instance is locked.
+ * @exception E_OBJECT_LOCKED The DataSet instance is locked.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position.
+ * @remarks If MoveNext() is called after this method, the cursor goes to the first position.
*/
virtual result Reset(void);
/**
- * Gets an @c int value from the column whose index is specified.
+ * Gets the @c int value from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The integer value obtained from the specified column
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetIntAt(int columnIndex, int& value) const;
/**
- * Gets a @c long @c long value from the column whose index is specified.
+ * Gets the @c long @c long value from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The 64-bit integer value obtained from the specified column
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetInt64At(int columnIndex, long long& value) const;
/**
- * Gets a @c double value from the column whose index is specified.
+ * Gets the @c double value from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The double value obtained from the specified column
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetDoubleAt(int columnIndex, double& value) const;
/**
- * Gets a Tizen::Base::String value from the column whose index is specified.
+ * Gets the Tizen::Base::String value from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The Tizen::Base::String value obtained from the specified column
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The Tizen::Base::String value obtained from the specified column
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
+ * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range.
*/
virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const;
/**
- * Gets a Tizen::Base::ByteBuffer value from the column whose index is specified.
+ * Gets the Tizen::Base::ByteBuffer value from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The Tizen::Base::ByteBuffer value obtained from the specified column @n
- * The %Tizen::Base::ByteBuffer will be filled from the current position and data copy
- * will be continued until %Tizen::Base::ByteBuffer limitation is reached or no more
+ * The %Tizen::Base::ByteBuffer will be filled from the current position and the data copying
+ * will be continued until the %Tizen::Base::ByteBuffer limitation is reached or no more
* blob data remains.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_OVERFLOW The specified Tizen::Base::ByteBuffer @c value is insufficient to save the data.
- * @see Tizen::Base::ByteBuffer
+ * @see Tizen::Base::ByteBuffer
*/
virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const;
/**
- * Gets a blob data from the column whose index is specified.
+ * Gets the blob data from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] buffer The user-provided buffer used to receive the blob data
- * @param[in] size The maximum buffer length in bytes
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] buffer The buffer to receive the blob data
+ * @param[in] size The maximum buffer length in bytes
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_INVALID_ARG Either the specified @c columnIndex is out of range or the specified @c size is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_OVERFLOW The specified @c buffer is insufficient to save the data.
*/
virtual result GetBlobAt(int columnIndex, void* buffer, int size) const;
/**
- * Gets a Tizen::Base::DateTime value from the column whose index is specified.
+ * Gets the Tizen::Base::DateTime value from the column with the specified index.
*
- * @since 2.1
+ * @since 2.1
*
- * @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @return An error code
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The Tizen::Base::DateTime value obtained from the specified column
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n
- * The date format should be 'mm/dd/yyyy hh:mm:ss'.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @exception E_INVALID_FORMAT Either of the following conditions has occurred:
+ * - The date is not correctly formatted. @n
+ * The date format should be 'mm/dd/yyyy hh:mm:ss'.
+ * - The method is trying to access column of type String.
* @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range,
* or the method is trying to access a column of type String.
*/
*
* @since 2.1
*
- * @return The number of columns in the calling enumerator, @n
+ * @return The number of columns in the current enumerator, @n
* else @c -1 if an exception occurs
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
+ * @remarks
+ * - The method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnCount(void) const;
/**
- * Gets the type of the column indicated by a specified index.
+ * Gets the type of the column specified by the index.
*
* @since 2.1
*
- * @return The type of column, @n
+ * @return The column type, @n
* else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs
- * @param[in] columnIndex The index of the destination column
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] columnIndex The column index
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
+ * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual DbColumnType GetColumnType(int columnIndex) const;
/**
- * Gets the name of the column indicated by a specified index.
+ * Gets the name of the column specified by the index.
*
* @since 2.1
*
* @return The name of the column, @n
* else an empty string if an exception occurs
- * @param[in] columnIndex The index of the destination column
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] columnIndex The column index
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
+ * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
+ * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::String GetColumnName(int columnIndex) const;
/**
- * Gets the size of data in bytes.
+ * Gets the size of data in bytes of the column specified by the index.
*
* @since 2.1
*
* @return The size of the data in bytes, @n
* else @c -1 if an exception occurs
- * @param[in] columnIndex The index of the destination column
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
- * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * If the destination column is of type String, this method returns the @c byte length excluding
- * the @c null terminator character. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] columnIndex The column index
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.
+ * @exception E_INVALID_ARG The specified @c columnIndex is out of range.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnSize(int columnIndex) const;
/**
* @class Database
- * @brief This class provides the basic database and database entry management methods.
+ * @brief This class provides methods for database management.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %Database class provides the basic database and database entry management methods.
+ * The %Database class provides methods for database management.
* All members of this class are guaranteed to be thread-safe.
*
* For more information on the class features,
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 database file, @n
* else @c false to open an existing database 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 @c dbPath is invalid. @n
- * - The specified @c dbPath is invalid or the path ends with '/'. @n
- * - The directory name path is missing. @n
- * - The parent directory does not exist. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_FILE_ALREADY_EXIST The specified database file already exists. @n
- * Creation of database file has failed because the destination file already exists. @n
- * Creation of the database file is attempted if the file does not exist and
- * the specified @c createIfNotExist is @c true.
- * However, at this moment another thread has been already created the database file
- * with the same file path.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified @c dbPath is invalid.
+ * - The specified @c dbPath is invalid or the path ends with '/'.
+ * - The directory name path is missing.
+ * - The parent directory does not exist.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
+ * @exception E_FILE_ALREADY_EXIST Either of the following conditions has occurred:
+ * - The specified database file already exists.
+ * - The creation of the database file failed because the destination file already exists.
+ * - The creation of the database file is attempted if the file does not exist and the specified @c createIfNotExist is
+ * @c true. However, in this case, another thread has already created the database file with the same file path. @n
* This is a rare case, however, it is possible if a race condition is present between several threads.
* @exception E_FILE_NOT_FOUND The specified database file cannot be found or accessed.
- * @exception E_DATABASE Either of the following conditions has occurred: @n
- * - The method has failed to open or create a file. @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * @exception E_DATABASE Either of the following conditions has occurred:
+ * - The method has failed to open or create a file.
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %File corruption is detected.
- * @remarks To open the database file in the read-only mode,
- * use the Database::Construct(const Tizen::Base::String& dbPath, const char* pOpenMode) method
+ * @remarks To open the database file in the read-only mode, use the Database::Construct(const Tizen::Base::String&, const char*) method
* with "r" as the value for the open mode flag.
* @endcond
*/
*
* @return An error code
* @param[in] dbPath The path of the database file to open
- * @param[in] openMode An open mode flag @n
+ * @param[in] openMode The file opening mode flag @n
* Currently, the following flags can be used in combination with the logical OR operator: @n
* (1) DB_OPEN_READ_ONLY @n
* (2) DB_OPEN_READ_WRITE @n
* (3) DB_OPEN_READ_WRITE | DB_OPEN_CREATE
* @param[in] option This argument is reserved for further use
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified @c dbPath is invalid. @n
- * - The specified @c openMode is invalid. @n
- * - The specified @c dbPath is invalid or the path ends with '/'. @n
- * - The directory name path is missing. @n
- * - The parent directory does not exist. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified @c dbPath is invalid.
+ * - The specified @c openMode is invalid.
+ * - The specified @c dbPath is invalid or the path ends with '/'.
+ * - The directory name path is missing.
+ * - The parent directory does not exist.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified database file already exists.
* @exception E_FILE_NOT_FOUND The specified database file cannot be found or accessed.
- * @exception E_DATABASE Either of the following conditions has occurred: @n
- * - The method has failed to open or create a file. @n
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * @exception E_DATABASE Either of the following conditions has occurred:
+ * - The method has failed to open or create a file.
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %File corruption is detected.
* @endcond
*/
* - r+: Open for reading and writing.
* - a+: Open for writing and reading. The database 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
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The overall length of the specified @c dbPath is equal to @c 0 or
- * exceeds system limitations. @n
- * - The specified @c dbPath ends with '/'. @n
- * - The combination of the specified @c pOpenMode is not allowed. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * exceeds system limitations.
+ * - The specified @c dbPath ends with '/'.
+ * - The combination of the specified @c pOpenMode is not allowed.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified @c dbPath cannot be found.
* @exception E_INVALID_FORMAT The specified @c dbPath is not a database.
* @exception E_STORAGE_FULL The disk space is full.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @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 Construct(const Tizen::Base::String& dbPath, const char* pOpenMode);
* This method opens an existing secure database file or creates a new one according to the specified file opening mode.
* The contents written to the secure database file is automatically encrypted and the contents read from the secure database
* file is automatically decrypted by the platform. @n
- * Applications using this method can access the same secure database files that are created by other applications with the
+ * Applications using this method can access the secure database files that are created by other applications with an
* identical key value in same device. However, the secure files created by this method cannot be accessed in other devices.
*
* @since 2.0
* @return An error code
* @param[in] dbPath The path of the database file to open or create
* @param[in] pOpenMode The file opening mode @n
- * It can be one of the following: @n
- * - r : Open for reading @n
- * - r+: Open for reading and writing @n
- * - a+: Open for writing and reading. The database file is created if it does not exist. @n
- * @param[in] secretKey A key used to encrypt data of a database file or decrypt a secure database file @n
- * If a secure database file is created with a specific key value,
- * other applications can access the same secure database file with the identical key value.
+ * It can be one of the following:
+ * - r : Open for reading
+ * - r+: Open for reading and writing
+ * - a+: Open for writing and reading. The database file is created if it does not exist.
+ * @param[in] secretKey The key used to encrypt the data of the database file or decrypt the secure database file @n
+ * If the secure database file is created with a specific key value,
+ * other applications can access the secure database 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 @c dbPath is equal to @c 0 or
- * exceeds system limitations. @n
- * - The specified @c dbPath ends with '/'. @n
- * - The combination of the specified @c pOpenMode is not allowed. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * exceeds system limitations.
+ * - The specified @c dbPath ends with '/'.
+ * - The combination of the specified @c pOpenMode is not allowed.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified @c dbPath cannot be found.
* @exception E_INVALID_FORMAT The specified @c dbPath is not a database.
* @exception E_STORAGE_FULL The disk space is full.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @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_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see
* <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
result Construct(const Tizen::Base::String& dbPath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey);
/**
- * Creates a SQL statement for the current database.
+ * Creates an SQL statement for the current database.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* else @c null if an exception occurs
* @param[in] sqlStatement The SQL statement to compile
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c sqlStatement is invalid SQL.
+ * @exception E_INVALID_ARG The specified @c sqlStatement is an invalid SQL.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
DbStatement* CreateStatementN(const Tizen::Base::String& sqlStatement);
/**
- * Executes a statement in the calling %Database instance. @n
+ * Executes a statement in the current %Database instance. @n
* If an application opens a database file using Database::Construct(const Tizen::Base::String& dbPath,
* const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey),
* the data set written by INSERT/UPDATE is automatically encrypted by the Tizen platform and
- * the data set read by SELECT is also decrypted by itself.
+ * the data set read by SELECT is decrypted.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* SELECT query, or if one of INSERT, UPDATE, and DELETE queries is executed.
* @param[in] dbStatement The DbStatement instance to execute
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c dbStatement includes invalid SQL.
+ * @exception E_INVALID_ARG The specified @c dbStatement includes an invalid SQL.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
* @exception E_STORAGE_FULL The disk space or database image 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.
- * @remarks If @c dbStatement contains the SELECT query, the Reset() method of the DbEnumerator instance returned
- * from this method should be called. The Reset() method should be called before re-binding the dbStatement
+ * @remarks
+ * - If @c dbStatement contains the SELECT query, the Reset() method of the DbEnumerator instance returned
+ * from this method should be called. The %Reset() method should be called before re-binding the dbStatement
* with the bind methods of the DbStatement class.
- * This method returns an enumerator if the result set is generated by the SELECT query.
- * @c null is returned if no result set is available after the successful execution of the SELECT query.
+ * - This method returns an enumerator if the result set is generated by the SELECT query.
+ * @c null is returned if no result set is available after the successful execution of the SELECT query. @n
* Note that, a return value of @c null does not mean that the statement execution has failed.
- * The enumerator returned by the SELECT query does not indicate any row before it calls DbEnumerator::MoveNext().
- * The specific error code can be accessed using the GetLastResult() method.
+ * - The enumerator returned by the SELECT query does not indicate any row before it calls DbEnumerator::MoveNext().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
DbEnumerator* ExecuteStatementN(const DbStatement& dbStatement);
/**
- * Executes SQL statement in this %Database instance. @n
+ * Executes the specified SQL statement in the current %Database instance. @n
* Any SQL statement that does not give a result set can be run using this method; for example, CREATE, INSERT, UPDATE, DELETE.
* The SELECT query cannot be executed using this method. @n
* If an application opens a database file using Database::Construct(const Tizen::Base::String& dbPath,
* @param[in] sqlStatement The SQL statement to execute
* @param[in] option This argument is reserved for further use.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c sqlStatement is invalid SQL.
+ * @exception E_INVALID_ARG The specified @c sqlStatement is an invalid SQL.
* @exception E_INVALID_OPERATION The specified @c sqlStatement is a SELECT query.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
* @exception E_STORAGE_FULL The disk space or database image 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.
* @remarks Use QueryN() to execute SELECT query.
result ExecuteSql(const Tizen::Base::String& sqlStatement, bool option);
/**
- * Executes a SELECT query in the calling %Database instance. @n
+ * Executes the specified SELECT query in the current %Database instance. @n
* If an application opens a database file using Database::Construct(const Tizen::Base::String& dbPath,
* const char* pOpenMode, const Tizen::Base::ByteBuffer& key),
* the data set read by SELECT is automatically decrypted by the Tizen platform.
* else @c null if an exception occurs or if no result set is generated after the successful execution of the SELECT query
* @param[in] sqlStatement The SQL statement to execute
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c sqlStatement is invalid SQL.
+ * @exception E_INVALID_ARG The specified @c sqlStatement is an invalid SQL.
* @exception E_INVALID_OPERATION The specified @c sqlStatement is not a SELECT query.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
- * @remarks This method returns an enumerator if the result set is generated by the SELECT query.
- * @c null is returned if no result set is available after the successful execution of the SELECT query.
+ * @remarks
+ * - This method returns an enumerator if the result set is generated by the SELECT query.
+ * @c null is returned if no result set is available after the successful execution of the SELECT query. @n
* Note that, a return value of @c null does not mean that the statement execution has failed.
- * The enumerator returned by the SELECT query does not indicate any row before it calls
+ * - The enumerator returned by the SELECT query does not indicate any row before it calls
* DbEnumerator::MoveNext().
- * The specific error code can be accessed using the GetLastResult() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see ExecuteSql()
*/
DbEnumerator* QueryN(const Tizen::Base::String& sqlStatement);
result BeginTransaction(void);
/**
- * Commits a transaction within this %Database instance.
+ * Commits a transaction within the current %Database instance.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
* @exception E_STORAGE_FULL The disk space or database image 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.
* @remarks Database::CommitTransaction() automatically resets not only all the DbStatement instances
- * but also all the DbEnumerator instances obtained from the current %Database instance.
- * As a result, the prepared statement of the %DbStatement instances are reset to its initial state, ready to be re-executed,
- * and enumerator of the %DbEnumerator instances are reset to the first position.
- * Therefore, the user should be careful when the same instance of the %Database class is shared across multiple threads.
- * Further, access to the %DbStatement or %DbEnumerator instances resets due to commit operation. This will eventually lead to crash.
- * To avoid a crash, the user can use multiple database instances for each thread.
- * Sharing of the same database instance across multiple threads is not recommended.
+ * but also all the DbEnumerator instances obtained from the current %Database instance. @n
+ * As a result, the prepared statement of the %DbStatement instances are reset to its initial state, ready to be
+ * re-executed, and enumerator of the DbEnumerator instances are reset to the first position. @n
+ * Therefore, you should be careful when the same instance of the %Database class is shared across multiple
+ * threads. Further, access to the %DbStatement or %DbEnumerator instances resets due to a commit operation. @n
+ * This will eventually lead to a crash. To avoid a crash, you can use multiple database instances for each
+ * thread. Sharing of the same database instance across multiple threads is not recommended.
* @see BeginTransaction()
* @see RollbackTransaction()
*/
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
* @exception E_STORAGE_FULL The disk space or database image 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.
* @see BeginTransaction()
result RollbackTransaction(void);
/**
- * Gets the database's filename.
+ * Gets the database file name.
*
* @since 2.0
*
- * @return The filename of this %Database instance
+ * @return The file name of the current %Database instance
*/
Tizen::Base::String GetName(void) const;
* @return An error code
* @param[in] databasePath The path of the database file to delete
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified @c databasePath is invalid. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified @c databasePath is invalid.
* - The specified @c databasePath parameter contains an invalid path or
- * the path ends with '/'. @n
- * - The directory name path is missing. @n
- * - The parent directory does not exist. @n
+ * the path ends with '/'.
+ * - The directory name path is missing.
+ * - The parent directory does not exist.
* - An I/O security issue.
- * @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 database file cannot be found.
- * @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.
* - A system error has occurred.
*/
static result Delete(const Tizen::Base::String& databasePath);
/**
- * Checks whether the database file exists.
+ * Checks whether the specified database file exists.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* else @c false
* @param[in] databasePath The path of the database file to check
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified @c databasePath is invalid. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified @c databasePath is invalid.
* - The specified @c databasePath parameter contains an invalid path or
- * the path ends with '/'. @n
- * - The directory name path is missing. @n
- * - The parent directory does not exist. @n
+ * the path ends with '/'.
+ * - The directory name path is missing.
+ * - The parent directory does not exist.
* - An I/O security issue.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static bool Exists(const Tizen::Base::String& databasePath);
/**
- * Converts a normal database file to a secure database file. @n
+ * Converts the specified normal database file to a secure database file. @n
* A secure database file, that is converted by this method, can be shared among applications with the same key value.
*
* @if OSPCOMPAT
* @return An error code
* @param[in] normalDbPath The normal (non-encrypted) database file path
* @param[in] secureDbPath The secure (encrypted) database file path to create
- * @param[in] secretKey A key to encrypt normal database file @n
+ * @param[in] secretKey The key to encrypt the normal database file @n
* If the normal database file is converted with a specific key value,
- * applications can access the same secure database file with the identical key value.
+ * applications can access the secure database 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
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path is invalid. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is @c 0 or exceeds system limitations.
+ * - The specified path is invalid.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified @c normalDbPath does not exist.
* @exception E_FILE_ALREADY_EXIST The specified @c secureDbPath already exists.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAlT The database file is malformed.
* @exception E_STORAGE_FULL The disk space or database image 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.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see
*
* @since 2.0
*
- * @return Row ID of the most recent successful insert, @n
+ * @return The row ID of the most recent successful insert, @n
* else @c -1 if no successful INSERT operations have ever occurred on
* the current opened database.
- * @remarks The row ID is always available as an undeclared column named ROWID, OID, or _ROWID_
- * as long as those names are not also used by explicitly declared columns.
- * If the table has a column of type INTEGER PRIMARY KEY then that column is another alias
- * for the row ID. @n
- * This method returns the row ID of the most recent successful INSERT operation
- * for current %Database.
+ * @remarks
+ * - The row ID is always available as an undeclared column named ROWID, OID, or _ROWID_
+ * as long as those names are not used by explicitly declared columns.
+ * - If the table has a column of type ::INTEGER PRIMARY KEY then that column is another alias
+ * for the row ID.
+ * - This method returns the row ID of the most recent successful INSERT operation
+ * for the current %Database instance.
*/
long long GetLastInsertRowId(void) const;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
- * @see Tizen::Io::Database::ExecuteStatementN()
- * @see Tizen::Io::Database::QueryN()
- * @see Tizen::Io::DbEnumerator::MovePrevious()
- * @see Tizen::Io::DbEnumerator::MoveFirst()
- * @see Tizen::Io::DbEnumerator::MoveLast()
+ * @see Tizen::Io::Database::ExecuteStatementN()
+ * @see Tizen::Io::Database::QueryN()
+ * @see Tizen::Io::DbEnumerator::MovePrevious()
+ * @see Tizen::Io::DbEnumerator::MoveFirst()
+ * @see Tizen::Io::DbEnumerator::MoveLast()
*/
virtual result MoveNext(void);
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
- * @see Tizen::Io::Database::ExecuteStatementN()
- * @see Tizen::Io::Database::QueryN()
- * @see Tizen::Io::DbEnumerator::MoveNext()
- * @see Tizen::Io::DbEnumerator::MoveFirst()
- * @see Tizen::Io::DbEnumerator::MoveLast()
+ * @see Tizen::Io::Database::ExecuteStatementN()
+ * @see Tizen::Io::Database::QueryN()
+ * @see Tizen::Io::DbEnumerator::MoveNext()
+ * @see Tizen::Io::DbEnumerator::MoveFirst()
+ * @see Tizen::Io::DbEnumerator::MoveLast()
*/
virtual result MovePrevious(void);
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
- * @see Tizen::Io::Database::ExecuteStatementN()
- * @see Tizen::Io::Database::QueryN()
- * @see Tizen::Io::DbEnumerator::MoveNext()
- * @see Tizen::Io::DbEnumerator::MovePrevious()
- * @see Tizen::Io::DbEnumerator::MoveLast()
+ * @see Tizen::Io::Database::ExecuteStatementN()
+ * @see Tizen::Io::Database::QueryN()
+ * @see Tizen::Io::DbEnumerator::MoveNext()
+ * @see Tizen::Io::DbEnumerator::MovePrevious()
+ * @see Tizen::Io::DbEnumerator::MoveLast()
*/
virtual result MoveFirst(void);
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
- * @see Tizen::Io::Database::ExecuteStatementN()
- * @see Tizen::Io::Database::QueryN()
- * @see Tizen::Io::DbEnumerator::MoveNext()
- * @see Tizen::Io::DbEnumerator::MovePrevious()
- * @see Tizen::Io::DbEnumerator::MoveFirst()
+ * @see Tizen::Io::Database::ExecuteStatementN()
+ * @see Tizen::Io::Database::QueryN()
+ * @see Tizen::Io::DbEnumerator::MoveNext()
+ * @see Tizen::Io::DbEnumerator::MovePrevious()
+ * @see Tizen::Io::DbEnumerator::MoveFirst()
*/
virtual result MoveLast(void);
/**
- * Resets the calling %DbEnumerator instance back to its initial state.
+ * Resets the current %DbEnumerator instance to its initial state.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to reset the enumerator of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position.
+ * @remarks If MoveNext() is called after this method, the cursor goes to the first position.
*/
virtual result Reset(void);
/**
- * Gets an @c int value from the column whose index is specified.
+ * Gets the @c int value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The integer value obtained from the column
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The integer value obtained from the specified column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetIntAt(int columnIndex, int& value) const;
/**
- * Gets a @c long @c long value from the column whose index is specified.
+ * Gets the @c long @c long value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The 64-bit integer value obtained from the column
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The 64-bit integer value obtained from the specified column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetInt64At(int columnIndex, long long& value) const;
/**
- * Gets a @c double value from the column whose index is specified.
+ * Gets the @c double value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The value obtained from the column as a double
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The double value obtained from the column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetDoubleAt(int columnIndex, double& value) const;
/**
- * Gets a @c String value from the column whose index is specified.
+ * Gets the @c String value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The value obtained from the column as a String
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The @c String value obtained from the column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or
- * it is possible if the database file is corrupted.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred:
+ * - The string conversion has failed due to invalid encoding range.
+ * - The database file is corrupted.
*/
virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const;
/**
- * Gets a byte array value from the column whose index is specified.
+ * Gets the byte array value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The user-provided buffer used to receive the blob data as a stream of type ByteBuffer @n
- * The buffer will be filled from the current position and data copy will be continued
- * until buffer limitation is reached or no more blob data remains. @n
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The buffer to receive the blob data as a stream of type ByteBuffer @n
+ * The buffer will be filled from the current position and the data copying will be continued
+ * until the buffer limitation is reached or no more blob data remains. @n
* The maximum size available is limited to 100 MByte.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_OUT_OF_RANGE The byte buffer operation has failed.
* @exception E_OVERFLOW The specified @c value of the byte buffer is insufficient to save the data.
*/
virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const;
/**
- * Gets a blob data from the column whose index is specified.
+ * Gets the blob data from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] buffer The user-provided buffer used to receive the blob data @n
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] buffer The buffer to receive the blob data @n
* The maximum size available is limited to 100 MByte.
* @param[out] size The maximum buffer length in bytes
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range, or the specified @c size is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_OVERFLOW The specified @c buffer is insufficient to save the data.
*/
virtual result GetBlobAt(int columnIndex, void* buffer, int size) const;
/**
- * Gets a @c DateTime value from the column whose index is specified.
+ * Gets the @c DateTime value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The value obtained from the column as a DateTime instance
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The value obtained from the column as a %DateTime instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n
- * The date format should be 'mm/dd/yyyy hh:mm:ss'.
- * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range,
- * or the method is trying to access a column of type String.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @exception E_INVALID_FORMAT The date is not correctly formatted. The date format should be 'mm/dd/yyyy hh:mm:ss'.
+ * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, or the method is trying to access a column having an invalid value.
+ *
*/
virtual result GetDateTimeAt(int columnIndex, Tizen::Base::DateTime& value) const;
*
* @since 2.0
*
- * @return The number of columns in the calling enumerator, @n
+ * @return The number of columns in the current enumerator, @n
* else @c -1 if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnCount(void) const;
/**
- * Gets the type of the column indicated by the specified index.
+ * Gets the type of the column specified by the index.
*
* @since 2.0
*
- * @return The type of column, @n
+ * @return The column type, @n
* else DB_COLUMNTYPE_UNDEFINED if an exception occurs
- * @param[in] columnIndex The index of the destination column
+ * @param[in] columnIndex The column index
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - Currently, ::DB_COLUMNTYPE_INT is returned for a 64-bit integer.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual DbColumnType GetColumnType(int columnIndex) const;
/**
- * Gets the name of the column indicated by the specified index.
+ * Gets the name of the column specified by the index.
*
* @since 2.0
*
* @return The name of the column, @n
* else an empty string if an exception occurs
- * @param[in] columnIndex The index of the destination column
+ * @param[in] columnIndex The column index
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or
- * it is possible if the database file is corrupted.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred:
+ * - The string conversion has failed due to invalid encoding range.
+ * - The database file is corrupted.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::String GetColumnName(int columnIndex) const;
/**
- * Gets the size of data in bytes.
+ * Gets the size of data in bytes of the column specified by the index.
*
* @since 2.0
*
* @return The size of the data in bytes, @n
* else @c -1 if an exception occurs
- * @param[in] columnIndex The index of the destination column
+ * @param[in] columnIndex The column index
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* - The Database or DbStatement instance associated with this instance is deleted.
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnSize(int columnIndex) const;
/**
* @class DbStatement
- * @brief This class provides a method for evaluating pre-compiled statements.
+ * @brief This class provides methods for evaluating pre-compiled statements.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %DbStatement class provides a method for evaluating pre-compiled statements.
- * All members of this class are guaranteed to be thread-safe.
+ * The %DbStatement class provides methods for evaluating pre-compiled statements.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/io/database_operations.htm">Database Operations</a>.
*/
virtual ~DbStatement(void);
/**
- * Binds an integer value to the statement parameter.
+ * Binds the specified integer value to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The column index to bind the value
* @param[out] value The integer value to bind
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
* @exception E_INVALID_ARG The specified @c columnIndex is invalid.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindInt(int columnIndex, int value);
/**
- * Binds a @c long @c long value to the statement parameter.
+ * Binds the specified @c long @c long value to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The column index to bind the value
* @param[out] value The 64-bit integer value to bind
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
* @exception E_INVALID_ARG The specified @c columnIndex is invalid.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindInt64(int columnIndex, long long value);
/**
- * Binds a @c double value to the statement parameter.
+ * Binds the specified @c double value to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The column index to bind the value
* @param[out] value The @c double value to bind
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
* @exception E_INVALID_ARG The specified @c columnIndex is invalid.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindDouble(int columnIndex, double value);
/**
- * Binds a String value to the statement parameter.
+ * Binds the specified string value to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The column index to bind the value
* @param[out] value The string value to bind
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
* @exception E_INVALID_ARG The specified @c value exceeds size limit.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindString(int columnIndex, const Tizen::Base::String& value);
/**
- * Binds a value of type ByteBuffer to the statement parameter.
+ * Binds the specified ByteBuffer type value to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The column index to bind the value
* @param[out] value The blob value to bind @n
* The maximum available size is limited to 100 MBytes.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c columnIndex is invalid. @n
- * - The size of byte buffer is less than @c 0 or has @c null data. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c columnIndex is invalid.
+ * - The size of the byte buffer is less than @c 0 or has @c null data.
* - The specified @c value exceeds size limit.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
* @remarks The bound @c byte array size is from the current position of byte buffer to the limit.
*/
result BindBlob(int columnIndex, const Tizen::Base::ByteBuffer& value);
/**
- * Binds the raw blob data to the statement parameter.
+ * Binds the specified raw blob data to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The index of the column to bind the value
* @param[in] buffer A pointer to the buffer where blob data is located @n
* The maximum available size is limited to 100 MBytes.
* @param[in] size The blob data length in bytes
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c columnIndex is invalid. @n
- * - The specified @c size is less than @c 0. @n
- * - The pointer to the buffer is @c null. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c columnIndex is invalid.
+ * - The specified @c size is less than @c 0.
+ * - The pointer to the buffer is @c null.
* - The specified @c buffer exceeds size limit.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindBlob(int columnIndex, const void* buffer, int size);
/**
- * Binds a DateTime value to the statement parameter.
+ * Binds the specified DateTime value to the statement parameter.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The index of the column to bind the value
* @param[out] value The date value to bind
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
- * @exception E_INVALID_ARG The specified @c columnIndex is invalid, or
- * the value is less than @c or a @c null pointer.
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c columnIndex is invalid.
+ * - The value is less than @c or a @c null pointer.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindDateTime(int columnIndex, const Tizen::Base::DateTime& value);
* @endif
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is bound
+ * @param[in] columnIndex The index of the column to bind the @c null value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The instance has not been properly constructed,
- * or the instance is finalized.
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - The instance has not been properly constructed.
+ * - The instance is finalized.
* @exception E_INVALID_ARG The specified @c columnIndex is invalid.
* @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset
- * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext().
+ * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n
* In this case DbEnumerator::Reset() should be invoked before calling this method.
*/
result BindNull(int columnIndex);
* @file FIoDbTypes.h
* @brief This is the header file for the %DbColumnType enumerator.
*
- * This header file contains the declarations of the %DbColumnType enumerator.
+ * This header file contains the declarations of the DbColumnType enumerator.
*/
#ifndef _FIO_DB_TYPES_H_
/**
* @class DirEntry
- * @brief This class stores the information about each directory entry.
+ * @brief This class provides methods for the information about each directory entry.
*
* @since 2.0
*
*
* @since 2.0
*
- * @return A reference to the calling instance
+ * @return A reference to the current instance
* @param[in] rhs An instance of %DirEntry
*/
DirEntry& operator =(const DirEntry& rhs);
/**
- * Compares the specified instance of Object to the calling instance of %DirEntry.
+ * Compares the specified instance of Tizen::Base::Object to the calling instance of %DirEntry.
*
* @since 2.0
*
*
* The %DirEnumerator class provides methods to access the collection of a specific directory entry list.
* Generally, %DirEnumerator is instantiated by the Directory::ReadN() method,
- * and used to get the %DirEntry instances that have information pertaining to the directory.
+ * and used to get the DirEntry instances that have information pertaining to the directory.
*
* For more information on the class features,
* see <a href="../org.tizen.native.appprogramming/html/guide/io/io_namespace.htm">Io Guide</a>.
* @return A reference to the DirEntry instance
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The current position of the collection is not valid.
- * @remarks Use the MoveNext() method to get information from another file or directory to the currently accessed directory. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - Use the MoveNext() method to get information from another file or directory to the currently accessed directory.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
DirEntry GetCurrentDirEntry(void) const;
/**
- * Gets the pointer to the object at the current position of a directory entry collection.
+ * Gets a pointer to the object at the current position of a directory entry collection.
*
* @since 2.0
*
/**
* Moves the current position of the collection to the next position in the currently accessed directory. @n
- * When %DirEnumerator is instantiated, its initial position is set to @c -1. @n
- * Therefore, calling the GetCurrentDirEntry() method without a call to MoveNext() throws an E_INVALID_STATE exception,
+ * When DirEnumerator is instantiated, its initial position is set to @c -1. @n
+ * Therefore, calling the GetCurrentDirEntry() method without a call to MoveNext() throws an @c E_INVALID_STATE exception,
* and returns a reference to an empty DirEntry instance. @n
* Similarly, calling the GetCurrent() method without a call to MoveNext() returns a @c null pointer to indicate an error condition.
*
*
* @return An error code
* @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 path is @c 0 or exceeds
- * system limitations. @n
- * - The specified path is invalid. @n
+ * system limitations.
+ * - The specified path is invalid.
* - The file handle is invalid (the file is closed by another method).
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
* @exception E_END_OF_FILE There are no more directory entries to read.
* @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_IO Either of the following conditions has occurred:
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %File corruption is detected.
*/
virtual result MoveNext(void);
/**
* @class Directory
- * @brief This class provides methods to operate on directories.
+ * @brief This class provides methods for directory operations.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %Directory class provides methods to operate on directories.
+ * The %Directory class provides methods for directory operations.
*
* 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
*
* @return An error code
* @param[in] dirPath The path to the directory to open
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @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 An entry for the specified file or path cannot be found.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
- * @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.
*/
result Construct(const Tizen::Base::String& dirPath);
* @return A pointer to the DirEnumerator object that provides a way to access the collection of a directory entry list, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @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_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.
- * @remarks The returned enumeration objects should be released by the caller. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The returned enumeration objects should be released by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
DirEnumerator* ReadN(void);
* @endif
*
* @return An error code
- * @param[in] dirPath The path at which the directory is created
- * @param[in] createParentDirectories Set to @c true if the non-existing parent directories are created automatically
+ * @param[in] dirPath The path to create the directory
+ * @param[in] createParentDirectories Set to @c true to create the non-existing parent directories automatically
* up to the destination, @n
- * else @c false if an absent parent directory causes an exception
+ * else @c false to throw an exception in case of absent parent directory
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is @c 0 or exceeds system limitations.
* - The specified path is invalid.
- * @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_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_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.
*/
static result Create(const Tizen::Base::String& dirPath, bool createParentDirectories = false);
* @param[in] recursive Set to @c true to remove the sub-directories recursively, @n
* else @c false
* @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 path is @c 0 or exceeds
- * system limitations. @n
+ * system limitations.
* - The specified @c dirPath is not directory path.
- * @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 dirPath cannot be found.
* @exception E_FILE_ALREADY_EXIST The specified directory already exists.
* @exception E_MAX_EXCEEDED The number of opened directories has exceeded the maximum limit.
- * @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.
*/
static result Remove(const Tizen::Base::String& dirPath, bool recursive = false);
* @param[in] orgDirPath The original directory path
* @param[in] newDirPath The new directory path
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is @c 0 or exceeds system limitations.
* - The specified path is invalid.
- * @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 An entry for the specified file or path cannot be found.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @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.
*/
static result Rename(const Tizen::Base::String& orgDirPath, const Tizen::Base::String& newDirPath);
enum FileSeekPosition
{
FILESEEKPOSITION_BEGIN, /**<The beginning of the file */
- FILESEEKPOSITION_CURRENT, /**<The current position of the file */
+ FILESEEKPOSITION_CURRENT, /**<The current position in the file */
FILESEEKPOSITION_END /**<The end of the file */
};
/**
* @class File
- * @brief This class provides the basic file I/O operations, such as read, write, create, and remove.
+ * @brief This class provides the file I/O operations, such as read, write, create, and remove.
*
* @since 2.0
*
* The %File class provides the basic file I/O operations, such as read, write, create, and remove.
* It only provides synchronous file read-write with raw data bytes (UTF-8) or string data.
* It is constructed using the Construct() method to access files and control file I/O operations.
- * There is no method like Close() to close the opened file instances.
+ * It does not provide a Close() method to close the opened file instances.
* The only way to close an opened file is by invoking the destructor of the %File class.
* Therefore, if the %File class is instantiated as a local variable, it is not closed until it goes out of scope.
- * To get a detailed information on a file or directory, use the FileAttributes and Directory classes.
+ * To get detailed information on a file or directory, use the FileAttributes and Directory classes.
*
- * When an application is installed, the application has its own storage area, which is application root directory.
+ * When an application is installed, the application has its own storage area, which is the application root directory.
* The application root directory path can be obtained by calling Tizen::App::App::GetAppRootPath().
* The following are some of the sub-directories of the application root directory:
- * - data - Used to store and access private data of an application (read-write permission) @n
- * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"data"
- * or Tizen::App::App::GetInstance()->GetAppDataPath().
- * - res - Used to read resource files that are delivered with the application package (read-only permission) @n
- * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"res"
- * or Tizen::App::App::GetInstance()->GetAppResourcePath().
- * - shared - Used to share data and resource files with other applications @n
- * There are data and res directories under the shared directory.
- * Use Tizen::App::App::GetInstance()->GetAppRootPath() + L"shared" to access its own shared directory and
- * use Tizen::App::AppManager::GetAppSharedPath() to access other application's shared directory. @n
+ * - data - Used to store and access private data of an application (read-write permission) @n
+ * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"data"
+ * or Tizen::App::App::GetInstance()->GetAppDataPath().
+ * - res - Used to read resource files that are delivered with the application package (read-only permission) @n
+ * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"res"
+ * or Tizen::App::App::GetInstance()->GetAppResourcePath().
+ * - shared - Used to share data and resource files with other applications @n
+ * Shared directory has data and res directories.
+ * Use Tizen::App::App::GetInstance()->GetAppRootPath() + L"shared" to access its own shared directory and
+ * use Tizen::App::AppManager::GetAppSharedPath() to access other application's shared directory.
*
* For more information on the path,
* see <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/io_overview.htm">I/O Overview</a>.
*
- * For more information on class features,
+ * For more information on the class features,
* see <a href="../org.tizen.native.appprogramming/html/guide/io/io_namespace.htm">Io Guide</a>.
*
* The following example demonstrates how to use the %File class.
* @if OSPCOMPAT
* @page CompIoPathPage Compatibility for path
* @section CompIoPathPageIssueSection Issues
- * The path argument of this method in OSP compatible applications has the following issue: @n
+ * The path argument of this method in OSP compatible applications has the following issue:
*
* -# The path should begin with an allowed path prefix such as '/Home', '/Home/Share', '/Res', '/Share/[@e appid]',
* '/Media', and '/Storagecard/Media'.
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
*/
* - a+: Open for appending and reading. The file is created if it does not exist.
* @param[in] createParentDirectories Set to @c true to automatically create non-existent parent directories up to destination, @n
* else @c false @n
- * This parameter is useful only if the specified @c openMode allows creation of an absent
- * file. For example, the following modes: "w", "w+", "a" and "a+". @n
+ * This parameter is useful only if the specified @c openMode is "w", "w+", "a" or "a+"
+ * that allows the creation of an absent file. @n
* If the value of @c openMode is not any one of these, E_INVALID_ARG exception is thrown.
* @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. @n
- * - The combination of the specified @c openMode is not allowed. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * exceeds system limitations.
+ * - The combination of the specified @c openMode is not allowed.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode such as "w" or "a".
* @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @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.
- * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+",
- * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n
- * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally.
+ * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+",
+ * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n
+ * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored
+ * internally.
* @endcond
*/
result Construct(const Tizen::Base::String& filePath, const Tizen::Base::String& openMode, bool createParentDirectories);
* - a : Open for appending. The file is created if it does not exist.
* - a+: Open for appending and reading. The 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
+ * @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. @n
- * - The combination of the specified @c openMode is not allowed. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * exceeds system limitations.
+ * - The combination of the specified @c openMode is not allowed.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode such as "w" or "a".
* @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @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.
- * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+",
- * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n
- * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally.
+ * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+",
+ * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n
+ * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored
+ * internally.
*/
result Construct(const Tizen::Base::String& filePath, const Tizen::Base::String& openMode);
* - a : Open for appending. The file is created if it does not exist.
* - a+: Open for appending and reading. The 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
+ * @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. @n
- * - The combination of the specified @c pOpenMode is not allowed. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * exceeds system limitations.
+ * - The combination of the specified @c pOpenMode is not allowed.
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode such as "w" or "a".
* @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @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.
- * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+",
- * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n
- * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally.
+ * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+",
+ * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n
+ * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored
+ * internally.
*/
result Construct(const Tizen::Base::String& filePath, const char* pOpenMode);
* This method opens an existing secure file or creates a new one according to the specified file opening mode. @n
* The contents written to the secure file is automatically encrypted and the contents read from the secure file is automatically
* decrypted by the platform. @n
- * Applications using this method can access the secure files that are created by other applications with the identical key value
- * in same device. However, the secure files created by this method cannot be accessed in other devices.
+ * Applications using this method can access the secure files that are created by other applications with an identical key value
+ * in the same device. However, the secure files created by this method cannot be accessed in other devices.
*
* @since 2.0
*
* otherwise it is truncated to zero length.
* - a : Open for appending. The file is created if it does not exist.
* - a+: Open for appending and reading. The file is created if it does not exist.
- * @param[in] secretKey A key used to encrypt data of a file or decrypt a secure file @n
- * If a secure file is created with a specific key value,
- * other applications can access the same secure file with the identical key value.
+ * @param[in] secretKey The key used to encrypt the data of the file or decrypt the secure file @n
+ * If the secure file is created with a specific key value,
+ * other applications can access the secure 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 file is corrupted.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode such as "w" or "a".
* @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @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.
- * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+",
- * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n
- * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally.
+ * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+",
+ * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n
+ * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored
+ * internally.
*/
result Construct(const Tizen::Base::String& filePath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey);
/**
* Reads the byte data from the current file pointer. @n
* The user-specified ByteBuffer is filled with the byte data from the current position in the file.
- * The read operation continues until the specified ByteBuffer is filled or end-of-file is met. @n
+ * The read operation continues until the specified ByteBuffer is filled or the end of file is reached. @n
* In the secure mode, the byte data read from the secure file is automatically decrypted by a platform security module.
*
* @since 2.0
*
* @return An error code
- * @param[in, out] buffer A reference to the buffer that is used to receive the byte data read from the file
+ * @param[in, out] buffer The reference to the buffer to copy the byte data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c buffer has no space to store the read data.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for read operation. @n
- * - Access is denied due to insufficient permission.
- * @exception E_END_OF_FILE The file pointer has reached end-of-file.
- * @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 Either of the following conditions has occurred:
+ * - The file is not opened for read operation.
+ * - The access is denied due to insufficient permission.
+ * @exception E_END_OF_FILE The file pointer has reached the end of file.
+ * @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.
- * @remarks The ByteBuffer should be constructed before being passed to the method.
+ * @remarks The ByteBuffer should be constructed before being passed to this method.
*/
result Read(Tizen::Base::ByteBuffer& buffer);
/**
- * Reads the byte data from the current file pointer and copies it into the specified buffer. @n
+ * Reads the byte data from the current file pointer and copies it to the specified buffer. @n
* In the secure mode, the byte data read from the secure file is automatically decrypted by a platform security module.
*
* @since 2.0
*
* @return The length of the data read in bytes, @n
* else @c 0 in case of failure
- * @param[out] buffer A pointer to the user-supplied buffer where the read data is copied
+ * @param[out] buffer The pointer to the buffer to copy the byte data
* @param[in] length The buffer length in bytes
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c buffer contains a @c null pointer. @n
- * - The length of the specified @c buffer is equal to or smaller than @c 0. @n
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for read operation. @n
- * - Access is denied due to insufficient permission.
- * @exception E_END_OF_FILE The file pointer has reached end-of-file.
- * @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_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c buffer contains a @c null pointer.
+ * - The length of the specified @c buffer is equal to or smaller than @c 0.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The file is not opened for read operation.
+ * - The access is denied due to insufficient permission.
+ * @exception E_END_OF_FILE The file pointer has reached the end of file.
+ * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int Read(void* buffer, int length);
/**
- * Reads the string data from the current file pointer and copies the string to the specified buffer (it is assumed that the
- * file is in the UTF-8 format). @n
- * The read operation continues until new line character or end-of-file is met. @n
+ * Reads the string data from the current file pointer and copies it to the specified buffer. @n
+ * It is assumed that the file is in the UTF-8 format.
+ * The read operation continues until a new line character or end-of-file is reached. @n
* In the secure mode, the string data read from the secure file is automatically decrypted by a platform security module.
*
* @since 2.0
*
* @return An error code
- * @param[out] buffer A reference to the buffer where the data is copied
+ * @param[out] buffer A reference to the buffer to copy the string data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c buffer is invalid.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for read operation. @n
- * - Access is denied due to insufficient permission.
- * @exception E_END_OF_FILE The file pointer reached end-of-file.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The file is not opened for read operation.
+ * - The access is denied due to insufficient permission.
+ * @exception E_END_OF_FILE The file pointer reached the end of file.
* @exception E_IO Either of the following conditions has occurred:
- * - An unexpected device failure has occurred as the media ejected suddenly. @n
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* - %File corruption is detected.
- * @remarks To get the expected string value
- * from a file, which is not in the UTF-8 format (Unicode or any other format),
- * user should use other encoding or decoding methods of the Tizen::Text namespace after reading the content of
- * a file in binary format. @n
- * The maximum length of characters read by this method is defined as 4096. @n
- * Therefore, if the length of a single line (considering new line character or end-of-file) from the current
+ * @remarks To get the expected string value from a file, which is not in the UTF-8 format
+ * (Unicode or any other format), the user should use other encoding or decoding methods of the
+ * Tizen::Text namespace after reading the content of the file in binary format. @n
+ * The maximum length of characters read by this method is defined as @c 4096. @n
+ * Therefore, if the length of a single line (till a new line character or end-of-file is reached) from the current
* file position is longer than 4096, the rest of the characters remain as not read. @n
- * 'ByteBuffer' or 'void*' version of the File::Read() API can be used to overcome this limitation.
+ * The 'ByteBuffer' or 'void*' version of the File::Read() API can be used to overcome this limitation.
*/
result Read(Tizen::Base::String& buffer);
/**
- * Writes the byte data from the specified ByteBuffer into a file beginning at the current position to the limit of the
- * %ByteBuffer. @n
- * In the secure mode, the byte data written by a user is automatically encrypted to the secure file by a platform security module. @n
- * The size of a secure file can be greater than the size of a normal (original) file
- * because of the encryption.
- * However, the file pointer for the secure file is equal to the file pointer for the original file.
+ * Writes the byte data from the specified Tizen::Base::ByteBuffer beginning at the current position to the limit of the %Tizen::Base::ByteBuffer
+ * to a file . @n
+ * In the secure mode, the byte data written is automatically encrypted to a secure file by the platform security module. @n
+ * The size of a secure file can be greater than the size of a normal (original) file because of the encryption.
+ * However, the file pointer for a secure file is equal to the file pointer for an original file.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer A reference to the buffer that contains byte data to write
+ * @param[in] buffer A reference to the buffer that contains the byte data to write
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c buffer is invalid.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for write operation. @n
- * - Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The file is not opened for write operation.
+ * - The access is denied due to insufficient permission.
* @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.
*/
result Write(const Tizen::Base::ByteBuffer& buffer);
/**
- * Writes the byte data into a file. @n
- * In the secure mode, the byte data written by a user is automatically encrypted to the secure file by a platform security module. @n
- * The size of a secure file can be greater than the size of a normal (original) file
- * because of the encryption.
- * However, the file pointer for the secure file is equal to the file pointer for the original file.
+ * Writes the byte data from the specified buffer to a file. @n
+ * In the secure mode, the byte data written is automatically encrypted to a secure file by the platform security module. @n
+ * The size of a secure file can be greater than the size of a normal (original) file because of the encryption.
+ * However, the file pointer for a secure file is equal to the file pointer for an original file.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer A pointer to the user-supplied buffer that contains @c byte data to write
+ * @param[in] buffer A pointer to the buffer that contains the @c byte data to write
* @param[in] length The buffer length in bytes
* @exception E_SUCCESS The method is successful.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for write operation. @n
- * - Access is denied due to insufficient permission.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c buffer contains a @c null pointer. @n
- * - The specified @c buffer length is equal or smaller than @c 0. @n
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The file is not opened for write operation.
+ * - The access is denied due to insufficient permission.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c buffer contains a @c null pointer.
+ * - The specified @c buffer length is equal or smaller than @c 0.
* @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.
*/
result Write(const void* buffer, int length);
/**
- * Writes the string data into a file. @n
- * In the secure mode, the string data written by a user is automatically encrypted to the secure file by a platform security
- * module. @n
- * The size of a secure file can be greater than the size of a normal (original) file
- * because of the encryption.
- * However, the file pointer for the secure file is equal to the file pointer for the original file.
+ * Writes the string data from the specified buffer to a file. @n
+ * In the secure mode, the string data written is automatically encrypted to a secure file by the platform security module. @n
+ * The size of a secure file can be greater than the size of a normal (original) file because of the encryption.
+ * However, the file pointer for a secure file is equal to the file pointer for an original file.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer A reference to the buffer that contains string data to write
+ * @param[in] buffer A reference to the buffer that contains the string data to write
* @exception E_SUCCESS The method is successful.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for write operation. @n
- * - Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The file is not opened for write operation.
+ * - The access is denied due to insufficient permission.
* @exception E_INVALID_ARG The specified @c buffer contains an empty string.
* @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.
*/
result Write(const Tizen::Base::String& buffer);
/**
- * Flushes the internally buffered data to kernel memory of the underlying operating system.
+ * Flushes the internally buffered data to the kernel memory of the underlying operating system.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @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_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.
*/
result Flush(void);
/**
* Gets the offset of the current file pointer relative to the beginning of the file. @n
- * The size of a secure file can be greater than the size of a normal (original) file
- * because of the encryption.
- * However, the file pointer for the secure file is equal to the file pointer for the original file.
+ * The size of a secure file can be greater than the size of a normal (original) file because of the encryption.
+ * However, the file pointer for a secure file is equal to the file pointer for an original file.
*
* @since 2.0
*
* @return The offset of the current file pointer, @n
* else @c -1L if an error occurs
* @exception E_SUCCESS The method is successful.
- * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Seek()
int Tell(void) const;
/**
- * Repositions the file pointer associated with an opened file. @n
+ * Repositions the file pointer associated with the opened file. @n
* Each opened file has its own file pointer, and it points to the next byte to be read or written in the file.
* The repositioning offset can be specified with respect to the beginning of file, current position, or end of the file.
* If the file pointer is over the end-of-file, it expands the file size to the specified position and the expanded area is
* filled with zero. @n
- * The size of a secure file can be greater than the size of a normal (original) file
- * because of the encryption.
- * However, the file pointer for the secure file is equal to the file pointer for the original file.
+ * The size of a secure file can be greater than the size of a normal (original) file because of the encryption.
+ * However, the file pointer for a secure file is equal to the file pointer for an original file.
*
* @since 2.0
*
* @return An error code
- * @param[in] position The origin from where to start the repositioning a file pointer
+ * @param[in] position The starting position to reposition the file pointer
* @param[in] offset The number of bytes to move a file pointer @n
* A negative offset moves the pointer backwards.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c position or @c offset is invalid.
- * @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_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.
* @see FileSeekPosition
*/
/**
* Truncates the file size to the specified length. @n
- * If the specified length is less than the length of file, the bytes present between the @c length and size of a file are
- * removed.
- * If the file size is small, its size is increased. @n
- * The size of a secure file can be greater than the size of a normal (original) file
- * because of the encryption.
+ * If the specified length is less than the length of file, the bytes present between the specified @c length and size of
+ * the file are removed. If the file size is small, its size is increased. @n
+ * The size of a secure file can be greater than the size of a normal (original) file because of the encryption.
* However, the file pointer for a secure file is equal to the file pointer for an original file.
*
* @since 2.0
* @return An error code
* @param[in] length The required file size in bytes after this method is executed
* @exception E_SUCCESS The method is successful.
- * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
- * - The file is not opened for write operation. @n
- * - Access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The file is not opened for write operation.
+ * - The access is denied due to insufficient permission.
* @exception E_INVALID_ARG The specified @c length has a negative value.
* @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.
*/
result Truncate(int length);
/**
- * Gets the path associated with a constructed %File.
+ * Gets the path associated with the %File.
*
* @since 2.0
*
- * @return The file path to the currently constructed %File if successful, @n
+ * @return The path of the currently constructed %File, @n
* else an empty string in case of failure
*/
Tizen::Base::String GetName(void) const;
/**
- * Acquires the file lock on the current opened whole file if it is not acquired.
+ * Acquires the file lock on the current opened whole file if it is not acquired. @n
* If the file lock is already acquired by another process, the current process is blocked until the file lock is
* released.
*
* @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 type of the 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_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);
/**
- * Acquires the file lock on the specified region of the current opened file if it is not acquired.
+ * Acquires the file lock on the specified region of the current opened file if it is not acquired. @n
* If the file lock is already acquired by another process, the current process is blocked until the file lock is
* released.
*
* @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
* @param[in] offset The starting offset for the locked region
* @param[in] length The length of the locked region in bytes
* @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 specified @c lockType is invalid.
* - The specified @c offset or @c length is negative or is greater than
* the system limitation.
- * @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, int offset, int length);
/**
- * 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.
+ * Tries to acquire the file lock on the current opened whole file. @n
+ * 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);
/**
- * Tries to acquire the file lock on the specified region of the current opened file.
- * If the file lock is already acquired by another process, E_OBJECT_LOCKED is returned.
+ * Tries to acquire the file lock on the specified region of the current opened file. @n
+ * 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
* @param[in] offset The starting offset for the locked region
* @param[in] length The length of the locked region in bytes
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c lockType is invalid.
- * - The specified @c offset or @c length is negative or is greater than
- * the system limitation.
- * @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_ARG Either of the following conditions has occurred:
+ * - The specified @c lockType is invalid.
+ * - The specified @c offset or @c length is negative or is greater than
+ * the system limitation.
+ * @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, int offset, int length);
* @return An error code
* @param[in] filePath The path of the file to delete
* @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. @n
+ * exceeds system limitations.
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode.
* @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
- * @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.
* @remarks The opened file cannot be deleted.
*/
static result Remove(const Tizen::Base::String& filePath);
/**
- * Moves the specified file to another location. @n
+ * Moves the specified file to the specified location. @n
* The opened files cannot be moved. This method is static.
*
* @if OSPCOMPAT
* @param[in] oldFilePath The old file path
* @param[in] newFilePath The new file path
* @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. @n
+ * exceeds system limitations.
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode.
- * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
+ * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @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.
* @see Copy()
- * @see Remove()
+ * @see Remove()
*/
static result Move(const Tizen::Base::String& oldFilePath, const Tizen::Base::String& newFilePath);
/**
- * Copies the existing source file to the destined location. @n
+ * Copies the existing source file to the specified destination file path. @n
* This method is static.
*
* @since 2.0
* @param[in] failIfExist Set to @c true to return an error if the destination file already exists, @n
* else @c false
* @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. @n
+ * exceeds system limitations.
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n
+ * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n
* For example, opening a read-only file in the write mode.
- * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
+ * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @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.
* @see Move()
- * @see Remove()
+ * @see Remove()
*/
static result Copy(const Tizen::Base::String& srcFilePath, const Tizen::Base::String& destFilePath, bool failIfExist);
/**
- * Reads the file information such as size, attribute, creation date, and so on. @n
+ * Gets the attributes of the specified file such as size, attribute, creation date, and so on. @n
* This method is static.
*
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param[in] filePath The path of the file @n
+ * @param[in] filePath The path of the file
* @param[out] attribute A %File attribute instance
* @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. @n
+ * exceeds system limitations.
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
- * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found.
- * @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_FILE_NOT_FOUND The specified @c filePath cannot be found.
+ * @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 GetAttributes(const Tizen::Base::String& filePath, FileAttributes& attribute);
/**
- * Gets only the file name from the specified file path. @n
+ * Gets the file name from the specified file path. @n
* For example, if the file path passed is 'xxx/file.txt', 'file.txt' is returned.
*
* @if OSPCOMPAT
* @endif
*
* @return The file name of type String
- * @param[in] filePath The path of the file
+ * @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
* @return The file extension, @n
* else an empty string if the file has no extension
- * @param[in] filePath The path of the file
+ * @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* For more information, see @ref CompIoPathPage "here".
* @endif
*
- * @return @c true if file or directory exists, @n
+ * @return @c true if the file or directory exists, @n
* else @c false
* @param[in] filePath The path of the file or directory
* @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. @n
+ * exceeds system limitations.
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - Access is denied due to insufficient permission.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static bool IsFileExist(const Tizen::Base::String& filePath);
* @return An error code
* @param[in] plainFilePath The normal (non-encrypted) file path
* @param[in] secureFilePath The secure (encrypted) file path to create
- * @param[in] key A key that encrypts a secure file @n
- * If the secure file is converted with a specific key value,
- * applications can access the same secure file with the identical key value.
+ * @param[in] key The key that encrypts the secure file @n
+ * If the secure file is converted with the specific key value,
+ * applications can access the secure 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. @n
- * - The specified path is invalid. @n
- * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
+ * exceeds system limitations.
+ * - 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_FILE_NOT_FOUND The specified @c filePath cannot be found.
* @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 ConvertToSecureFile(const Tizen::Base::String& plainFilePath, const Tizen::Base::String& secureFilePath, const Tizen::Base::ByteBuffer& key);
/**
* @class FileAttributes
- * @brief This class provides a collection of basic file attributes.
+ * @brief This class provides methods for file attributes.
*
* @since 2.0
*
FileAttributes(const FileAttributes& rhs);
/**
- * Assigns the value of the specified instance to the current instance of %FileAttributes.
+ * Assigns the specified value of the specified instance to the current instance of %FileAttributes.
*
* @since 2.0
*
FileAttributes& operator =(const FileAttributes& rhs);
/**
- * Compares the specified instance of Object to the calling instance of %FileAttributes.
+ * Compares the specified instance of Tizen::Base::Object to the current instance of %FileAttributes.
*
* @since 2.0
*
*/
enum FileEventType
{
- FILE_EVENT_TYPE_ACCESS = 0x01, /**<%File was accessed (read)*/
- FILE_EVENT_TYPE_ATTRIBUTE = 0x04, /**<Metadata changed*/
- FILE_EVENT_TYPE_CLOSE_WRITE = 0x08, /**<%File opened for writing was closed*/
- FILE_EVENT_TYPE_CLOSE_NOWRITE = 0x10, /**<%File not opened for writing was closed*/
- FILE_EVENT_TYPE_CREATE = 0x100, /**<%File/directory created in monitored directory*/
- FILE_EVENT_TYPE_DELETE = 0x200, /**<%File/directory deleted from monitored directory*/
- FILE_EVENT_TYPE_DELETE_SELF = 0x400, /**<Monitored file/directory was itself deleted.*/
- FILE_EVENT_TYPE_MODIFY = 0x02, /**<%File was modified*/
- FILE_EVENT_TYPE_MOVE_SELF = 0x800, /**<Monitored file/directory was itself moved.*/
- FILE_EVENT_TYPE_MOVED_FROM = 0x40, /**<%File moved out of monitored directory. */
- FILE_EVENT_TYPE_MOVED_TO = 0x80, /**<%File moved into monitored directory. */
- FILE_EVENT_TYPE_OPEN = 0x20 /**<%File was opened. */
+ FILE_EVENT_TYPE_ACCESS = 0x01, /**< %File was accessed (read) */
+ FILE_EVENT_TYPE_ATTRIBUTE = 0x04, /**< Metadata was changed */
+ FILE_EVENT_TYPE_CLOSE_WRITE = 0x08, /**< %File opened for writing was closed */
+ FILE_EVENT_TYPE_CLOSE_NOWRITE = 0x10, /**< %File not opened for writing was closed */
+ FILE_EVENT_TYPE_CREATE = 0x100, /**< %File/directory created in monitored directory */
+ FILE_EVENT_TYPE_DELETE = 0x200, /**< %File/directory deleted from monitored directory */
+ FILE_EVENT_TYPE_DELETE_SELF = 0x400, /**< Monitored file/directory was itself deleted */
+ FILE_EVENT_TYPE_MODIFY = 0x02, /**< %File was modified */
+ FILE_EVENT_TYPE_MOVE_SELF = 0x800, /**< Monitored file/directory was itself moved.*/
+ FILE_EVENT_TYPE_MOVED_FROM = 0x40, /**< %File moved out of monitored directory */
+ FILE_EVENT_TYPE_MOVED_TO = 0x80, /**< %File moved into monitored directory */
+ FILE_EVENT_TYPE_OPEN = 0x20 /**< %File was opened */
};
/**
- * All file event types.
+ * All the file event types.
*
* @since 2.0
*/
/**
* @class FileEventManager
- * @brief This class provides a mechanism for monitoring file system events.
+ * @brief This class provides methods for monitoring file system events.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %FileEventManager class can be used to monitor individual files or directories. When a directory is monitored, this class will send an event for the directory or file itself, and for sub-files or sub-directories inside the observed directory.
+ * The %FileEventManager class can be used to monitor individual files or directories. When a directory is monitored,
+ * this class will send an event for the directory or file itself, and for sub-files or sub-directories inside the observed directory.
*
* @code
*
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
*/
virtual ~FileEventManager(void);
/**
- * Initializes this instance of %FileEventManager. @n
+ * Initializes this instance of %FileEventManager.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener A listener invoked when monitored files are changed.
+ * @param[in] listener The listener to be invoked when monitored files are changed
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit.
- * @exception E_IO Either of the following conditions has occurred: @n
+ * @exception E_IO Either of the following conditions has occurred:
* - The specified listener cannot be registered in worker thread.
* - Detected corruption of a file.
*/
/**
- * Adds a new monitor file, or modifies an existing monitor file, for the file whose location is specified in path; the application has to have read permission for this %path. %File event type can be set in %eventsToMonitor.
+ * Adds the monitor file, or modifies an existing monitor file in the specified path. @n
+ * The application must have read permission for this @c path. The file event type can be set in @c eventsToMonitor.
*
* @since 2.0
*
* @return An error code
* @param[in] path The path to the directory or file to monitor
* @param[in] eventsToMonitor The kind of event to monitor @n
- * Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
- * The Tizen::Io::FILE_EVENT_TYPE_ALL is provided for all file event type @n
- * If a specific eventsToMonitor is set, the events that have the specified file event are returned.
+ * Multiple event types can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
+ * The ::FILE_EVENT_TYPE_ALL is provided for all file event types. @n
+ * If a specific @c eventsToMonitor is set, the events that have the specified file event are returned.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified eventsToMonitor contains no valid events.
* @exception E_FILE_NOT_FOUND An entry for the specified path could not be found.
* @exception E_ILLEGAL_ACCESS The specified path is not permitted.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - The specified path outside of the process's accessible address space. @n
- * - The number of file monitor has been exceeded the maximum limit or
- * the failed to allocate a needed resource. @n
+ * @exception E_IO Either of the following conditions has occurred:
+ * - The specified path is outside the process's accessible address space.
+ * - The number of file monitors has exceeded the maximum limit.
+ * - Failed to allocate a needed resource.
* - Detected corruption of a file.
* @see FileEventType
*/
result AddPath(const Tizen::Base::String& path, unsigned long eventsToMonitor);
/**
- * Removes the monitored file associated with the current instance.
+ * Removes the specified monitored file associated with the current instance.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] path The path to the directory or file that is monitored
* @exception E_SUCCESS The method is successful.
* @exception E_IO The specified path is not monitored.
*/
enum FileLockType
{
- FILE_LOCK_SHARED, /**< More than one process can hold a shared file lock on a file region @n
+ FILE_LOCK_SHARED, /**< The shared file lock @n More than one process can hold a shared file lock on a file region @n
A shared lock prevents any other process from setting an exclusive lock on the file
- region. */
- FILE_LOCK_EXCLUSIVE /**< Only one process can hold an exclusive lock on a file region @n
+ region */
+ FILE_LOCK_EXCLUSIVE /**< The exclusive file lock @n Only one process can hold an exclusive lock on a file region @n
An exclusive lock prevents any other process from setting both shared and exclusive
- lock on the file region. */
+ lock on the file region */
};
/**
// limitations under the License.
//
/**
+ * @if OSPDEPREC
* @file FIoIChannelRequestEventListener.h
* @brief This is the header file for the %IChannelRequestEventListener interface.
*
* This header file contains the declarations of the %IChannelRequestEventListener interface.
+ * @endif
*/
#ifndef _FIO_ICHANNEL_REQUESTEVENT_LISTENER_H_
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @interface IChannelResponseEventListener
* @brief <i> [Deprecated] </i> This interface provides event handlers for any response events received through a channel.
*
-* @deprecated This class is deprecated. Instead of using this class, use the MessagePortManager class.
+* @deprecated This interface is deprecated. Instead of using this interface, use the MessagePortManager class.
* @since 2.0
*
* The %IChannelResponseEventListener interface provides event handlers for receiving the channel response events.
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query.
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to move the cursor position of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_INVALID_FORMAT The database file is malformed.
- * @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.
*/
virtual result MoveLast(void) = 0;
/**
- * Resets the calling %IDbEnumerator instance back to its initial state.
+ * Resets the calling %IDbEnumerator instance to its initial state.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to reset the enumerator of the result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_OBJECT_LOCKED The database instance is locked.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position.
+ * @remarks If MoveNext() is called after this method, the cursor goes to the first position.
*/
virtual result Reset(void) = 0;
/**
- * Gets an @c int value from the column whose index is specified.
+ * Gets the @c int value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The integer value obtained from the column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetIntAt(int columnIndex, int& value) const = 0;
/**
- * Gets a @c long @c long value from the column whose index is specified.
+ * Gets the @c long @c long value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The 64-bit integer value obtained from the column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetInt64At(int columnIndex, long long& value) const = 0;
/**
- * Gets a @c double value from the column whose index is specified.
+ * Gets the @c double value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The value obtained from the column as a double
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The double value obtained from the column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
*/
virtual result GetDoubleAt(int columnIndex, double& value) const = 0;
/**
- * Gets a @c String value from the column whose index is specified.
+ * Gets the @c String value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The value obtained from the column as a String
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The @c String value obtained from the column
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or
- * it is possible if the database file is corrupted.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred:
+ * - The string conversion has failed due to invalid encoding range.
+ * - The database file is corrupted.
*/
virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const = 0;
/**
- * Gets a byte array value from the column whose index is specified.
+ * Gets the byte array value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] value The user-provided buffer used to receive the blob data as a stream of type ByteBuffer @n
- * The buffer will be filled from the current position and data copy will be continued
- * until buffer limitation is reached or no more blob data remains. @n
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] value The buffer used to receive the blob data as a stream of type ByteBuffer @n
+ * The buffer will be filled from the current position and the data copying will be continued
+ * until the buffer limitation is reached or no more blob data remains. @n
* The maximum size available is limited to 100 MByte.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_OUT_OF_RANGE The byte buffer operation has failed.
* @exception E_OVERFLOW The specified @c value of the byte buffer is insufficient to save the data.
*/
virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const = 0;
/**
- * Gets a blob data from the column whose index is specified.
+ * Gets the blob data from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
- * @param[in,out] buffer The user-provided buffer used to receive the blob data @n
+ * @param[in] columnIndex The index of the column to get the value
+ * @param[in,out] buffer The buffer used to receive the blob data @n
* The maximum size available is limited to 100 MByte.
* @param[out] size The maximum buffer length in bytes
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range, or the specified @c size is invalid.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
* @exception E_OVERFLOW The specified @c buffer is insufficient to save the data.
*/
virtual result GetBlobAt(int columnIndex, void* buffer, int size) const = 0;
/**
- * Gets a @c DateTime value from the column whose index is specified.
+ * Gets the @c DateTime value from the column with the specified index.
*
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The index of the column whose value is required
+ * @param[in] columnIndex The index of the column to get the value
* @param[in,out] value The value obtained from the column as a DateTime instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.
- * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n
- * The date format should be 'mm/dd/yyyy hh:mm:ss'.
- * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range,
- * or the method is trying to access a column of type String.
+ * @exception E_TYPE_MISMATCH The column type accessed by the method do not match.
+ * @exception E_INVALID_FORMAT The date is not correctly formatted. The date format should be 'mm/dd/yyyy hh:mm:ss'.
+ * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, or the method is trying to access a column having an invalid value.
*/
virtual result GetDateTimeAt(int columnIndex, Tizen::Base::DateTime& value) const = 0;
*
* @since 2.0
*
- * @return The number of columns in the calling enumerator, @n
+ * @return The number of columns in the current enumerator, @n
* else @c -1 if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * (the query did not yield any result).
+ * @remarks
+ * - The method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnCount(void) const = 0;
/**
- * Gets the type of the column indicated by the specified index.
+ * Gets the type of the column specified by the index.
*
* @since 2.0
*
- * @return The type of column, @n
- * else DB_COLUMNTYPE_UNDEFINED if an exception occurs
- * @param[in] columnIndex The index of the destination column
+ * @return The column type, @n
+ * else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs
+ * @param[in] columnIndex The column index
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual DbColumnType GetColumnType(int columnIndex) const = 0;
/**
- * Gets the name of the column indicated by the specified index.
+ * Gets the name of the column specified by the index.
*
* @since 2.0
*
* @return The name of the column, @n
* else an empty string if an exception occurs
- * @param[in] columnIndex The index of the destination column
+ * @param[in] columnIndex The column index
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or
- * it is possible if the database file is corrupted.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred:
+ * - The string conversion has failed due to invalid encoding range.
+ * - The database file is corrupted.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::String GetColumnName(int columnIndex) const = 0;
/**
- * Gets the size of data in bytes.
+ * Gets the size of data in bytes of the column specified by the index.
*
* @since 2.0
*
* @return The size of the data in bytes, @n
* else @c -1 if an exception occurs
- * @param[in] columnIndex The index of the destination column
+ * @param[in] columnIndex The column index
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE Either of the following conditions has occurred: @n
- * - This instance has not been properly constructed. @n
+ * @exception E_INVALID_STATE Either of the following conditions has occurred:
+ * - This instance has not been properly constructed.
* - The method has tried to fetch the column data of a result set that is not activated
- * (the query did not yield any result). @n
+ * (the query did not yield any result).
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.
- * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n
- * If the destination column is of type %String, this method returns the @c byte length excluding the @c null terminator character. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method must be called after MoveNext(), MoveFirst(), or MoveLast().
+ * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual int GetColumnSize(int columnIndex) const = 0;
/**
* @interface IFileEventListener
-* @brief This listener interface is used for receiving file event.
+* @brief This listener interface is used for receiving file events.
*
* @since 2.0
*
-* The %IFileEventListener interface is used for receiving file event.
+* The %IFileEventListener interface is used for receiving file events.
*/
class _OSP_EXPORT_ IFileEventListener
: virtual public Tizen::Base::Runtime::IEventListener
*
* @return An error code
* @param[in] events The file event type @n
- * Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
- * Tizen::Io::FILE_EVENT_TYPE_ALL is provided for all file event type.
+ * Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
+ * ::FILE_EVENT_TYPE_ALL is provided for all file event type.
* @param[in] path The path to the directory or file where the event has occurred
* @param[in] eventId The event ID associating related events for single operation such as File::Move(), Directory::Rename()
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
/**
* Called when a message is received from a remote application. @n
- * This method will be called only if the remote application uses bidirectional communication method - RemoteMessagePort::SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessagee).
+ * This method will be called only if the remote application uses bidirectional communication method -
+ * RemoteMessagePort::SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessagee).
* The RemoteMessagePort instance can be used to send a response message to the message port of the remote application.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] pRemoteMessagePort The message port of a remote application which has sent this message
* @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair
/**
* Called when a message is received from a remote application. @n
- * This method will be called only if the remote application uses unidirectional communication method - RemoteMessagePort::SendMessage(const Tizen::Base::Collection::IMap* pMessage).
+ * This method will be called only if the remote application uses unidirectional communication method -
+ * RemoteMessagePort::SendMessage(const Tizen::Base::Collection::IMap* pMessage).
*
* @since 2.0
*
{
/**
-* @interface IMmcStorageFormatListener
-* @brief This interface is the listener to receive the result of external MMC format operations.
-* @since 2.0
+* @interface IMmcStorageFormatListener
+* @brief This interface is the listener to receive the result of external MMC format operations.
+* @since 2.0
*
* The %IMmcStorageFormatListener interface must be registered and implemented by an application to receive the result of
* external MMC format operations.
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface called.
*
* @since 2.0
*/
virtual ~IMmcStorageFormatListener(void) {}
/**
- * Called when external MMC format operation is done.
+ * Called when an external MMC format operation is completed.
*
* @since 2.0
*
- * @param[in] r The result of external MMC format operation
+ * @param[in] r The result of an external MMC format operation
* @exception E_SUCCESS The format operation is successful.
* @exception E_IO An unexpected device failure has occurred as the media ejected suddenly.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface called.
*
* @since 2.0
*/
virtual ~IMmcStorageMountListener(void) {}
/**
- * Called when external MMC mount operation is done.
+ * Called when the external MMC mount operation is completed.
*
* @since 2.0
*
* @param[in] r The result of external MMC mount operation
* @exception E_SUCCESS The mount operation is successful.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - The file system to be mounted has an invalid superblock.
- * - An unexpected device failure has occurred as the media ejected suddenly.
+ * @exception E_IO Either of the following conditions has occurred:
+ * - The file system to be mounted has an invalid superblock.
+ * - An unexpected device failure has occurred as the media ejected suddenly.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnMmcStorageMounted(result r) = 0;
/**
- * Called when external MMC unmount operation is done.
+ * Called when external MMC unmount operation is completed.
*
* @since 2.0
*
* @since 2.0
*
* @param[in] byteBuffer A byte buffer that contains the received data
- * @remarks The ByteBuffer instance needs to be deleted by the application.
+ * @remarks The ByteBuffer instance needs to be deleted by the application.
*/
virtual void OnSerialPortDataReceivedN(Tizen::Base::ByteBuffer& byteBuffer) = 0;
*
* @since 2.0
*
- * @param[in] r The error code
+ * @param[in] r The error code
* @exception E_INVALID_DATA The data is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnSerialPortErrorOccured(result r) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] listener The message port listener
- * @exception E_SUCCESS The method is successful.
+ * @param[in] listener The message port listener
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The listener instance already exists.
*/
result AddMessagePortListener(IMessagePortListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] listener The message port listener
+ * @param[in] listener The message port listener
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The listener instance is not found.
*/
result RemoveMessagePortListener(IMessagePortListener& listener);
/**
- * Gets the name of a local message port.
+ * Gets the name of the local message port.
*
* @since 2.0
*
- * @return The name of a local message port
+ * @return The name of the local message port
*/
Tizen::Base::String GetName(void) const;
/**
- * Checks whether an instance is a trusted message port or not.
+ * Checks whether the instance is a trusted message port or not.
*
* @since 2.0
*
*/
enum MemoryMappedFileFlag
{
- MEMORY_MAPPED_FILE_FLAG_SHARED = 0x01, /**< Changes are shared with other processes mapping the same file */
- MEMORY_MAPPED_FILE_FLAG_PRIVATE = 0x02, /**< Changes are not visible to other processes mapping the same file */
- MEMORY_MAPPED_FILE_FLAG_FIXED = 0x10 /**< This forces the system to use the specified mapping address exactly,
+ MEMORY_MAPPED_FILE_FLAG_SHARED = 0x01, /**< The changes are shared with other processes mapping the same file */
+ MEMORY_MAPPED_FILE_FLAG_PRIVATE = 0x02, /**< The changes are not visible to other processes mapping the same file */
+ MEMORY_MAPPED_FILE_FLAG_FIXED = 0x10 /**< The system is forced to use the specified mapping address exactly,
which should be a multiple of the page size */
};
/**
* @class MemoryMappedFile
- * @brief This class provides features mapping a file to virtual address space.
+ * @brief This class provides methods for mapping a file to virtual address space.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %MemoryMappedFile class provides features for using a memory mapped file,
+ * The %MemoryMappedFile class provides methods for using a memory mapped file,
* which maps the data of a file to an application's virtual address space.
*
* @code
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
*/
~MemoryMappedFile(void);
/**
- * Initializes this instance of %MemoryMappedFile with a specified file.
+ * Initializes this instance of %MemoryMappedFile with the specified file.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c file is not opened for reading. @n
* The opening mode should not be "w" or "a".
- * @remarks The specified @c file should be initialized by the Io::File::Construct() method.
+ * @remarks The specified @c file should be initialized by the Tizen::Io::File::Construct() method.
* @see Tizen::Io::File
*/
result Construct(const File& file);
* @since 2.0
*
* @return The mapped address space, @n
- * else @c null pointer if this method fails
- * @param[in] address A starting address of the mapping @n
+ * else @c null pointer if it fails
+ * @param[in] address The starting address of the mapping @n
* If the specified @c address is @c null, the system chooses the address.
* It should be a multiple of the page size.
* @param[in] length The length of the mapping space
* @param[in] protection The memory protection of the mapping @n
- * It is either Base::Runtime::MEMORY_PROTECTION_MODE_NONE or the bitwise-inclusive OR of one
+ * It is either ::MEMORY_PROTECTION_MODE_NONE or the bitwise-inclusive OR of one
* or more of the other modes in Base::Runtime::MemoryProtectionMode.
* @param[in] flag The flag providing information about the handling of a memory mapped file @n
* It is the bitwise-inclusive OR of the flags in Tizen::Io::MemoryMappedFileFlag.
* @param[in] offset The start offset of the specified file @n
* It should be a multiple of the page size.
* @exception E_SUCCESS The method is successful.
- * @exception E_ILLEGAL_ACCESS The specified @c flag is MEMORY_MAPPED_FILE_FLAG_SHARED and the specified @c
- * protection is MEMORY_PROTECTION_MODE_WRITE, but the specified file of
+ * @exception E_ILLEGAL_ACCESS The specified @c flag is ::MEMORY_MAPPED_FILE_FLAG_SHARED and the specified @c
+ * protection is ::MEMORY_PROTECTION_MODE_WRITE, but the specified file of
* MemoryMappedFile::Construct() is not opened with read-write mode.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c address or @c offset is not aligned on a page boundary. @n
- * - The specified @c length is not positive. @n
- * - The specified @c protection, @c flag, or @c offset @ is invalid. @n
- * - The specified @c flag cannot contain both MEMORY_MAPPED_FILE_FLAG_PRIVATE and
- * MEMORY_MAPPED_FILE_FLAG_SHARED.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c address or @c offset is not aligned on a page boundary.
+ * - The specified @c length is not positive.
+ * - The specified @c protection, @c flag, or @c offset @ is invalid.
+ * - The specified @c flag cannot contain both ::MEMORY_MAPPED_FILE_FLAG_PRIVATE and
+ * ::MEMORY_MAPPED_FILE_FLAG_SHARED.
* @exception E_MAX_EXCEEDED The number of mapped regions has exceeded the maximum limit.
* @exception E_OBJECT_LOCKED The mapped file has been locked.
- * @exception E_OUT_OF_MEMORY Either of the following conditions has occurred: @n
- * - The memory is insufficient. @n
- * - The specified @c flag is MEMORY_MAPPED_FILE_FLAG_FIXED, and the specified address
+ * @exception E_OUT_OF_MEMORY Either of the following conditions has occurred:
+ * - The memory is insufficient.
+ * - The specified @c flag is ::MEMORY_MAPPED_FILE_FLAG_FIXED, and the specified address
* range exceeds that allowed for the address space of a current process.
- * @exception E_IO Either of the following conditions has occurred: @n
- * - The underlying file system does not support memory mapping. @n
- * - The specified @c protection is MEMORY_PROTECTION_MODE_EXEC, but the mapped file
- * exists on a file system that has been mounted no-exec.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * When this instance is destructed, all mappings are deleted automatically.
+ * @exception E_IO Either of the following conditions has occurred:
+ * - The underlying file system does not support memory mapping.
+ * - The specified @c protection is ::MEMORY_PROTECTION_MODE_EXEC, but the mapped file
+ * exists on a file system that has been mounted no-exec.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - When this instance is destructed, all mappings are deleted automatically.
* @see Tizen::Base::Runtime::MemoryManager
*/
void* Map(void* address, long long length, unsigned long protection, unsigned long flag, long long offset);
/**
* Deletes the mapping of the specified address space. @n
* Further references to the addresses within the range result in generation of an invalid memory access. @n
- * This method flushes all changes of a shared mapping to the correlated file on the permanent storage.
+ * This method flushes all the changes of a shared mapping to the correlated file on the permanent storage.
*
* @since 2.0
*
* @param[in] address The memory mapping address to unmap
* @param[in] length The length of the mapping space
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c address is not aligned on a page boundary. @n
- * - The specified @c length is not positive. @n
- * - The specified address range is out of the valid address space of a current process.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c address is not aligned on a page boundary.
+ * - The specified @c length is not positive.
+ * - The specified address range is out of the valid address space of the current process.
* @remarks When this instance is destructed, all mappings of the instance are not unmapped automatically.
*/
result Unmap(void* address, long long length);
/**
- * Flushes all changes of an address range to the correlated file on the permanent storage.
+ * Flushes all the changes of an address range to the correlated file on the permanent storage.
*
* @since 2.0
*
* @param[in] length The length of the mapping space
* @param[in] syncFlag The synchronization option
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c address is not aligned on a page boundary. @n
- * - The specified @c length is not positive. @n
- * - The specified @c syncFlag is invalid. @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c address is not aligned on a page boundary.
+ * - The specified @c length is not positive.
+ * - The specified @c syncFlag is invalid.
* - The specified @c address space is not mapped.
- * @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.
* @remarks The specific page size of a current file system is provided by Tizen::System::SystemInfo class with
* "StorageInfo" key.
public:
/**
* Requests for a LocalMessagePort instance with the specified message port name. @n
- * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. @n
+ * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name.
*
* @since 2.0
*
* @return A pointer to the LocalMessagePort instance, @n
* else @c null if it fails
- * @param[in] localMessagePortName The name of a local message port
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c localMessagePortName is empty.
- * @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] localMessagePortName The name of a local message port
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The @c localMessagePortName is empty.
+ * @exception E_SYSTEM The method has failed due to a severe system error.
+ * @remarks
+ * - It is not recommended to use the message port names that start with "http://tizen.org/messageport".
+ * @c E_INVALID_ARG may be returned because they are reserved by platform.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static LocalMessagePort* RequestLocalMessagePort(const Tizen::Base::String& localMessagePortName);
/**
- * Requests the RemoteMessagePort instance with the specified remote application ID and message port name. @n
- * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID and message port name.
+ * Requests for a RemoteMessagePort instance with the specified remote application ID and message port name. @n
+ * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID
+ * and message port name.
*
* @since 2.0
*
* else @c null if it fails
* @param[in] remoteAppId The remote application ID
* @param[in] remoteMessagePortName The remote message port name
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The remote application ID or the remote message port name is empty.
- * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The remote application ID or the remote message port name is empty.
+ * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static RemoteMessagePort* RequestRemoteMessagePort(const Tizen::App::AppId& remoteAppId, const Tizen::Base::String& remoteMessagePortName);
/**
* Requests for a trusted LocalMessagePort instance with the specified message port name. @n
* This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. @n
- * Communications over a trusted message port is allowed only if both the applications are signed with a certificate that is uniquely assigned to the developer.
+ * Communications over a trusted message port is allowed only if both the applications are signed with a certificate that is
+ * uniquely assigned to the developer.
*
* @since 2.0
*
* @return A pointer to the trusted LocalMessagePort instance, @n
* else @c null if it fails
- * @param[in] localMessagePortName The name of a local message port
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c localMessagePortName is empty.
- * @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] localMessagePortName The name of a local message port
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The @c localMessagePortName is empty.
+ * @exception E_SYSTEM The method has failed due to a severe system error.
+ * @remarks
+ * - It is not recommended to use the message port names that start with "http://tizen.org/messageport".
+ * @c E_INVALID_ARG may be returned because they are reserved by platform.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static LocalMessagePort* RequestTrustedLocalMessagePort(const Tizen::Base::String& localMessagePortName);
/**
- * Requests the trusted RemoteMessagePort instance with the specified message port name. @n
- * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID and message port name. @n
- * This message port allows communications only if the applications are signed with the same certificate which is uniquely assigned to the developer.
+ * Requests for a trusted RemoteMessagePort instance with the specified message port name. @n
+ * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID
+ * and message port name. @n
+ * This message port allows communications only if the applications are signed with the same certificate which is uniquely
+ * assigned to the developer.
*
* @since 2.0
*
* @return A pointer to the trusted RemoteMessagePort instance, @n
* else @c null if it fails
- * @param[in] remoteAppId The remote application ID
- * @param[in] remoteMessagePortName The name of a remote message port
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either @c remoteAppId or @c remoteMessagePortName is empty.
- * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
- * @exception E_CERTIFICATE_VERIFICATION_FAILED The target application is not signed with the same certificate.
- * @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @param[in] remoteAppId The remote application ID
+ * @param[in] remoteMessagePortName The name of a remote message port
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either @c remoteAppId or @c remoteMessagePortName is empty.
+ * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
+ * @exception E_CERTIFICATE_VERIFICATION_FAILED The target application is not signed with the same certificate.
+ * @exception E_SYSTEM The method has failed due to a severe system error.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static RemoteMessagePort* RequestTrustedRemoteMessagePort(const Tizen::App::AppId& remoteAppId, const Tizen::Base::String& remoteMessagePortName);
public:
/**
- * Gets the MMC storage manager instance.
+ * Gets the pointer to the %MmcStorageManager instance.
*
* @since 2.0
*
- * @return A pointer to %MmcStorageManager instance if this method is successful, @n
+ * @return The pointer to %MmcStorageManager instance if this method is successful, @n
* else @c null
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
static MmcStorageManager* GetInstance(void);
/**
- * Mounts file system of external MMC.
+ * Mounts the file system of the external MMC.
*
* @since 2.0
* @privlevel platform
* (%http://tizen.org/privilege/systemsetting.read is deprecated.)
*
* @return An error code
- * @exception E_SUCCESS Mount operation is successfully started.
+ * @exception E_SUCCESS The mount operation is successfully started.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_OPERATION The external MMC has already been mounted.
* @exception E_SERVICE_BUSY One of mount, unmount and format operations is ongoing.
result Mount(void);
/**
- * Unmounts file system of external MMC.
+ * Unmounts the file system of the external MMC.
*
* @since 2.0
* @privlevel platform
* (%http://tizen.org/privilege/systemsetting.read is deprecated.)
*
* @return An error code
- * @exception E_SUCCESS Unmount operation is successfully started.
+ * @exception E_SUCCESS The unmount operation is successfully started.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_OPERATION The external MMC has already been unmounted.
* @exception E_SERVICE_BUSY One of mount, unmount and format operations is ongoing.
result Unmount(void);
/**
- * Formats file system of external MMC.
+ * Formats the file system of the external MMC.
*
* @since 2.0
* @privlevel platform
* (%http://tizen.org/privilege/systemsetting.read is deprecated.)
*
* @return An error code
- * @exception E_SUCCESS Format operation is successfully started.
+ * @exception E_SUCCESS The format operation is successfully started.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_OPERATION The external MMC should be unmounted for format operation.
* @exception E_SERVICE_BUSY One of mount, unmount and format operations is ongoing.
/**
* @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);
public:
/**
- * Gets the name of a remote message port.
+ * Gets the name of the remote message port.
*
* @since 2.0
*
- * @return The name of a remote message port
+ * @return The name of the remote message port
*/
Tizen::Base::String GetName(void) const;
/**
- * Gets the ID of a remote application.
+ * Gets the ID of the remote application.
*
* @since 2.0
*
- * @return The ID of a remote application
+ * @return The ID of the remote application
*/
Tizen::App::AppId GetAppId(void) const;
/**
- * Checks whether an instance is a trusted message port or not.
+ * Checks whether an instance is a trusted message port.
*
* @since 2.0
*
*
* @since 2.0
*
- * @return An error code
- * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n
- * The recommended message size is under 4KB.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The message argument is not a map of key (String) and value (String or ByteBuffer) pair.
- * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
- * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
- * @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 4KB size.
+ * @return An error code
+ * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n
+ * The recommended message size is under 4KB.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The message argument is not a map of key (String) and value (String or ByteBuffer) pair.
+ * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
+ * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
+ * @exception E_SYSTEM The method has failed due to a severe system error.
+ * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large
+ * messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 4KB size.
*/
result SendMessage(const Tizen::Base::Collection::IMap* pMessage);
/**
- * Sends a message to the message port of a remote application. This method is used for the bidirectional communication.
+ * Sends a message to the message port of a remote application. @n
+ * This method is used for the bidirectional communication.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] pLocalMessagePort The local message port
- * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n
- * The recommended message size is under 4KB.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The local message port is @c null. @n
- * - The message argument is not a map of key (String) and value (String or ByteBuffer) pair.
- * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
- * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
- * @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 4KB size.
+ * @return An error code
+ * @param[in] pLocalMessagePort The local message port
+ * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n
+ * The recommended message size is under 4KB.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The local message port is @c null.
+ * - The message argument is not a map of key (String) and value (String or ByteBuffer) pair.
+ * @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
+ * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
+ * @exception E_SYSTEM The method has failed due to a severe system error.
+ * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large
+ * messages. @n
+ * @c E_MAX_EXCEEDED may be returned for messages over 4KB size.
*/
result SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessage);
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
*/
virtual ~SerialPort(void);
/**
- * Constructs a new serial port connection. @n
- * If the specified port is open, E_SYSTEM is returned.
+ * Constructs a new serial port connection with the specified serial port event listener. @n
+ * If the specified port is open, @c E_SYSTEM is returned.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] listener The serial port event listener
* @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Construct(ISerialPortEventListener& listener);
/**
- * Writes data to the output buffer synchronously.
+ * Writes the specified data synchronously.
*
* @since 2.0
*
* @return An error code
- * @param[in] byteBuffer A reference to the buffer that contains the string data to write
- * @exception E_SUCCESS The method is successful.
- * @exception E_MAX_EXCEEDED The buffer size has exceeded the maximum limit of the current device.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] byteBuffer A reference to the buffer that contains the string data to write
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_MAX_EXCEEDED The buffer size has exceeded the maximum limit of the current device.
+ * @exception E_SYSTEM A system error has occurred.
* @see GetWriteBufferSize()
*/
result Write(const Tizen::Base::ByteBuffer& byteBuffer);
/**
* Gets the size of the write buffer.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The size of the write buffer
+ * @return The size of the write buffer
* @remarks The size of the write buffer depends on the device.
*/
int GetWriteBufferSize(void) const;
*
* @final This class is not intended for extension.
*
-* The %ServerChannel class provides methods to receive a request from a client application. An application can receive a request from another application using the %ServerChannel class. The instance of %ServerChannel is retrieved using ServerChannel::GetInstance().
+* The %ServerChannel class provides methods to receive a request from a client application. An application can receive a
+* request from another application using the %ServerChannel class. The instance of %ServerChannel is retrieved using
+* ServerChannel::GetInstance().
*
* The following example demonstrates how to use the %ServerChannel class.
*
*
* @since 2.0
*
- * @return A pointer to the %ServerChannel instance, @n
+ * @return The pointer to the %ServerChannel instance, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*
* @since 2.0
*
- * @return A pointer to the %ServerChannel instance, @n
+ * @return The pointer to the %ServerChannel instance, @n
* else @c null if it fails
* @param[in] channelName The channel name
* @exception E_SUCCESS The method is successful.
/**
* @class SqlStatementBuilder
- * @brief This class provides methods for building SQL statement.
+ * @brief This class provides methods for building an SQL statement.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %SqlStatementBuilder class provides methods for building SQL statement.
+ * The %SqlStatementBuilder class provides methods for building an SQL statement.
*/
class _OSP_EXPORT_ SqlStatementBuilder
: public Tizen::Base::Object
public:
/**
- * Creates SQL SELECT statement.
+ * Creates an SQL SELECT statement.
*
* @since 2.0
*
- * @return A created SQL SELECT statement, @n
+ * @return The SQL SELECT statement, @n
* else an empty string in case of failure
- * @param[in] table A table name to query from
- * @param[in] pColumnList A list of column names to query @n
+ * @param[in] table The table name to query from
+ * @param[in] pColumnList The list of column names to query @n
* The type of objects contained in the specified @c pColumnList must be
* Tizen::Base::String class.
* If it is @c null, all columns are returned in result set.
- * @param[in] pWhere A filter to select desired rows to query @n
+ * @param[in] pWhere The filter to select the desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * @param[in] pOrder Sorting order of rows to query @n
+ * @param[in] pOrder The sorting order of rows to query @n
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
- * @param[in] pLimit Limitation of the number of rows to query @n
+ * @param[in] pLimit The limit of the number of rows to query @n
* It is the SQL 'LIMIT' clause excluding the 'LIMIT' itself.
- * @param[in] pGroup A filter to select a column grouping rows to query @n
+ * @param[in] pGroup The filter to select a column grouping rows to query @n
* It is the SQL 'GROUP BY' clause excluding the 'GROUP BY' itself.
- * @param[in] pHaving A filter for the group @n
+ * @param[in] pHaving The filter for the group @n
* It is the SQL 'HAVING' clause excluding the 'HAVING' itself.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c pOrder is @c null and @c pLimit is not @c null.
* - The specified @c pGroup is @c null and @c pHaving is not @c null.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLite SQL documents.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the value specified in the @c pWhere is string, the value must be wrapped in
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
+ * For more information on the SQL statement, see SQLite SQL documents.
*/
static Tizen::Base::String CreateSelectStatement(const Tizen::Base::String& table, const Tizen::Base::Collection::IList* pColumnList,
const Tizen::Base::String* pWhere, const Tizen::Base::String* pOrder = null, const Tizen::Base::String* pLimit = null,
const Tizen::Base::String* pGroup = null, const Tizen::Base::String* pHaving = null);
/**
- * Creates SQL INSERT statement.
+ * Creates an SQL INSERT statement.
*
* @since 2.0
*
- * @return A created SQL INSERT statement, @n
+ * @return The SQL INSERT statement, @n
* else an empty string in case of failure @n
- * @param[in] table A table name to insert
- * @param[in] insertMap Column-value pairs to insert @n
+ * @param[in] table The table name to insert
+ * @param[in] insertMap The column-value pairs to insert @n
* The type of objects contained in the specified @c insertMap must be
* Tizen::Base::String class.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c insertMap is empty.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the value specified in the @c insertMap is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLite SQL documents.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the value specified in the @c insertMap is string, the value must be wrapped in
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
+ * For more information on the SQL statement, see SQLite SQL documents.
*/
static Tizen::Base::String CreateInsertStatement(const Tizen::Base::String& table, const Tizen::Base::Collection::IMap& insertMap);
/**
- * Creates SQL UPDATE statement.
+ * Creates an SQL UPDATE statement.
*
* @since 2.0
*
- * @return A created SQL UPDATE statement, @n
+ * @return The SQL UPDATE statement, @n
* else an empty string in case of failure @n
- * @param[in] table A table name to update
- * @param[in] updateMap Column-value pairs to update @n
+ * @param[in] table The table name to update
+ * @param[in] updateMap The column-value pairs to update @n
* The type of objects contained in the specified @c updateMap must be
* Tizen::Base::String class.
- * @param[in] pWhere A filter to select desired rows to update @n
+ * @param[in] pWhere The filter to select desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c updateMap is empty.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLITE SQL documents.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
+ * For more information on the SQL statement, see SQLITE SQL documents.
*/
static Tizen::Base::String CreateUpdateStatement(const Tizen::Base::String& table, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere);
/**
- * Creates SQL DELETE statement.
+ * Creates an SQL DELETE statement.
*
* @since 2.0
*
- * @return A created SQL DELETE statement, @n
+ * @return The SQL DELETE statement, @n
* else an empty string in case of failure @n
- * @param[in] table A table name to query
- * @param[in] pWhere A filter to select desired rows to delete @n
+ * @param[in] table The table name to query
+ * @param[in] pWhere The filter to select desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
* If it is @c null, all rows are deleted.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
- * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
- * For more information on the SQL statement, see SQLITE SQL documents.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the value specified in the @c pWhere is string, the value must be wrapped in
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
+ * For more information on the SQL statement, see SQLITE SQL documents.
*/
static Tizen::Base::String CreateDeleteStatement(const Tizen::Base::String& table, const Tizen::Base::String* pWhere);
projects / platform / framework / native / appfw.git / commitdiff