Difference between revisions of "OpenDBX/C API/odbx rows affected"
(error) |
(header hierarchy) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
'''#include <odbx.h>''' | '''#include <odbx.h>''' | ||
| Line 6: | Line 5: | ||
odbx_result_t* '''result''' ) | odbx_result_t* '''result''' ) | ||
| − | = Description = | + | == Description == |
Returns the number of rows that have been changed by the current statement whose result was retrieved by [[OpenDBX result|odbx_result()]]. Affected rows are only returned for DELETE, INSERT or UPDATE statements and their number depends on the database implementation. Instead returning the number of rows which are matched by the WHERE clause, MySQL does only count the rows whose values have really been changed. | Returns the number of rows that have been changed by the current statement whose result was retrieved by [[OpenDBX result|odbx_result()]]. Affected rows are only returned for DELETE, INSERT or UPDATE statements and their number depends on the database implementation. Instead returning the number of rows which are matched by the WHERE clause, MySQL does only count the rows whose values have really been changed. | ||
| Line 12: | Line 11: | ||
The '''result''' parameter required by this function must be a valid result set returned by [[OpenDBX result|odbx_result()]] and must not have been feed to [[OpenDBX result_free|odbx_result_free()]] before. | The '''result''' parameter required by this function must be a valid result set returned by [[OpenDBX result|odbx_result()]] and must not have been feed to [[OpenDBX result_free|odbx_result_free()]] before. | ||
| − | = Return values = | + | == Return values == |
'''odbx_rows_affected()''' returns the number of changed rows on success and zero if the database server didn't alter any rows. A value of zero can be returned due to the conditions in the WHERE clause of the statement which doesn't match any rows. | '''odbx_rows_affected()''' returns the number of changed rows on success and zero if the database server didn't alter any rows. A value of zero can be returned due to the conditions in the WHERE clause of the statement which doesn't match any rows. | ||
| − | = Errors = | + | == Errors == |
This function will also return zero if the '''result''' parameter is invalid. | This function will also return zero if the '''result''' parameter is invalid. | ||
| − | = See also = | + | == See also == |
* [[OpenDBX result|odbx_result()]] | * [[OpenDBX result|odbx_result()]] | ||
Revision as of 18:42, 6 May 2007
#include <odbx.h>
uint64_t odbx_rows_affected(
odbx_result_t* result )
Description
Returns the number of rows that have been changed by the current statement whose result was retrieved by odbx_result(). Affected rows are only returned for DELETE, INSERT or UPDATE statements and their number depends on the database implementation. Instead returning the number of rows which are matched by the WHERE clause, MySQL does only count the rows whose values have really been changed.
The result parameter required by this function must be a valid result set returned by odbx_result() and must not have been feed to odbx_result_free() before.
Return values
odbx_rows_affected() returns the number of changed rows on success and zero if the database server didn't alter any rows. A value of zero can be returned due to the conditions in the WHERE clause of the statement which doesn't match any rows.
Errors
This function will also return zero if the result parameter is invalid.
See also
Back to Overview
