OpenDBX/C API/odbx row fetch - Revision history

Nose: moved OpenDBX/API/odbx row fetch to OpenDBX/C API/odbx row fetch

2009-04-28T21:14:58Z

moved OpenDBX/API/odbx row fetch to OpenDBX/C API/odbx row fetch

Nose: 1 revision(s)

2008-05-23T22:49:54Z

1 revision(s)

: docbook2x update

2008-05-23T22:49:54Z

docbook2x update

Nose: 1 revision(s)

2008-05-23T22:33:26Z

1 revision(s)

: docbook2x update

2008-05-23T22:33:26Z

docbook2x update

Nose: 1 revision(s)

2007-05-19T20:08:37Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

Nose: OpenDBX row fetch moved to OpenDBX/API/odbx row fetch

2007-05-17T15:17:53Z

OpenDBX row fetch moved to OpenDBX/API/odbx row fetch

Nose: /* See also */

2007-05-12T22:26:58Z

‎See also

Nose: header hierarchy

2007-05-06T16:43:27Z

header hierarchy

@@ Line 13: / Line 13: @@
 Moreover, it is necessary to fetch all rows from a result set until zero is returned indicating that no more rows are available. Otherwise - depending on the backend - an error may occur after calling [[OpenDBX/API/odbx_result|odbx_result]]() the next time or the outstanding rows will be returned within the next result.
-[[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]() requires a valid '''''result''''' object which was created by [[OpenDBX/API/odbx_result|odbx_result]](). It must not have been feed to [[OpenDBX/API/odbx_result_free|odbx_result_free]]() before.
+[[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]() requires a valid '''''result''''' object which was created by [[OpenDBX/API/odbx_result|odbx_result]](). It must not have been feed to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() before.
 == Return value ==
@@ Line 23: / Line 23: @@
 == Errors ==
-; -ODBX_ERR_PARAM : The '''''result''''' parameter is either NULL or the object is invalid. This is usually the case if result has been already feed to [[OpenDBX/API/odbx_result_free|odbx_result_free]]().
+; -ODBX_ERR_PARAM : The '''''result''''' parameter is either NULL or the object is invalid. This is usually the case if result has been already feed to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]().
 == See also ==

@@ Line 2: / Line 2: @@
 '''Retrieve rows from the result set'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_row_fetch'''(
       odbx_result_t* '''''result''''' )
@@ Line 17: / Line 17: @@
 == Return value ==
-[[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]() will return one ("1") as long as rows are available from the result set. After the last row has been made available, further calls to this function will return zero ("0") indicating that the result set doesn't contain more rows.
+[[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]() will return ODBX_ROW_NEXT ("1") as long as rows are available from the result set. After the last row has been made available, further calls to this function will return ODBX_ROW_DONE ("0") indicating that the result set doesn't contain more rows. The named constants are available since OpenDBX 1.3.2 and the numbers in brackets have to be used instead if a previous release is is the basis for the application development.
 In case of an error, values less than zero are returned encodeing the reason why the error occurred.
@@ Line 35: / Line 35: @@
 * [[OpenDBX/API/odbx_field_value|odbx_field_value]]()
 * [[OpenDBX/API/odbx_result|odbx_result]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Retrieve rows from the result set'''
   int '''odbx_row_fetch'''(
-      odbx_result_t* '''result''' )
+      odbx_result_t* '''''result''''' )
 == Description ==
-Retrieves the values of a row from the current result set returned by [[OpenDBX_result|odbx_result()]]. Until this function is invoked, no row and field data is available via [[OpenDBX_field_length|odbx_field_length()]] or [[OpenDBX_field_value|odbx_field_value()]] and these functions will return zero or NULL.
+Retrieves the values of a row from the current result set returned by [[OpenDBX/API/odbx_result|odbx_result]](). Until this function is invoked, no row and field data is available via [[OpenDBX/API/odbx_field_length|odbx_field_length]]() or [[OpenDBX/API/odbx_field_value|odbx_field_value]]() and these functions will return zero respectively NULL.
-Moreover, it is necessary to fetch all rows from a result set until zero is returned indicating that no more rows are available. Otherwise - depending on the backend - an error may occur after calling [[OpenDBX_result|odbx_result()]] the next time or the outstanding rows will be returned within the next result.
+Moreover, it is necessary to fetch all rows from a result set until zero is returned indicating that no more rows are available. Otherwise - depending on the backend - an error may occur after calling [[OpenDBX/API/odbx_result|odbx_result]]() the next time or the outstanding rows will be returned within the next result.
-'''odbx_row_fetch()''' requires a valid '''result''' object which was created by [[OpenDBX_result|odbx_result()]]. It must not have been feed to [[OpenDBX result_free|odbx_result_free()]] before.
+[[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]() requires a valid '''''result''''' object which was created by [[OpenDBX/API/odbx_result|odbx_result]](). It must not have been feed to [[OpenDBX/API/odbx_result_free|odbx_result_free]]() before.
-== Return values ==
+== Return value ==
-'''odbx_row_fetch()''' will return one ("1") as long as rows are available from the result set. After the last row has been made available, further calls to this function will return zero ("0") indicating that the result set doesn't contain more rows.
+[[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]() will return one ("1") as long as rows are available from the result set. After the last row has been made available, further calls to this function will return zero ("0") indicating that the result set doesn't contain more rows.
-In case of an error, values less than zero are returned which encode the reason why the error occurred.
+In case of an error, values less than zero are returned encodeing the reason why the error occurred.
 == Errors ==
-; -ODBX_ERR_PARAM : The '''result''' parameter is either NULL or the object is invalid. This is usually the case if '''result''' has been already feed to [[OpenDBX result_free|odbx_result_free()]].
+; -ODBX_ERR_PARAM : The '''''result''''' parameter is either NULL or the object is invalid. This is usually the case if result has been already feed to [[OpenDBX/API/odbx_result_free|odbx_result_free]]().
 == See also ==
-* [[OpenDBX column_count]]
+* [[OpenDBX/API/odbx_column_count|odbx_column_count]]()
-* [[OpenDBX column_name]]
+* [[OpenDBX/API/odbx_column_name|odbx_column_name]]()
-* [[OpenDBX column_type]]
+* [[OpenDBX/API/odbx_column_type|odbx_column_type]]()
-* [[OpenDBX error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
-* [[OpenDBX field_length]]
+* [[OpenDBX/API/odbx_field_length|odbx_field_length]]()
-* [[OpenDBX field_value]]
+* [[OpenDBX/API/odbx_field_value|odbx_field_value]]()
-* [[OpenDBX result]]
+* [[OpenDBX/API/odbx_result|odbx_result]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 29: / Line 29: @@
 * [[OpenDBX column_type]]
 * [[OpenDBX error]]
 * [[OpenDBX field_length]]
 * [[OpenDBX field_value]]

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 6: / Line 5: @@
       odbx_result_t* '''result''' )
-= Description =
+== Description ==
 Retrieves the values of a row from the current result set returned by [[OpenDBX_result|odbx_result()]]. Until this function is invoked, no row and field data is available via [[OpenDBX_field_length|odbx_field_length()]] or [[OpenDBX_field_value|odbx_field_value()]] and these functions will return zero or NULL.
@@ Line 14: / Line 13: @@
 '''odbx_row_fetch()''' requires a valid '''result''' object which was created by [[OpenDBX_result|odbx_result()]]. It must not have been feed to [[OpenDBX result_free|odbx_result_free()]] before.
-= Return values =
+== Return values ==
 '''odbx_row_fetch()''' will return one ("1") as long as rows are available from the result set. After the last row has been made available, further calls to this function will return zero ("0") indicating that the result set doesn't contain more rows.
@@ Line 20: / Line 19: @@
 In case of an error, values less than zero are returned which encode the reason why the error occurred.
-= Errors =
+== Errors ==
 ; -ODBX_ERR_PARAM : The '''result''' parameter is either NULL or the object is invalid. This is usually the case if '''result''' has been already feed to [[OpenDBX result_free|odbx_result_free()]].
-= See also =
+== See also ==
 * [[OpenDBX column_count]]

← Older revision	Revision as of 21:14, 28 April 2009
(No difference)

← Older revision	Revision as of 22:49, 23 May 2008
(No difference)

← Older revision	Revision as of 22:33, 23 May 2008
(No difference)

← Older revision	Revision as of 20:08, 19 May 2007
(No difference)

← Older revision	Revision as of 15:17, 17 May 2007
(No difference)