//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @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);
projects / platform / framework / native / appfw.git / blobdiff