'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH odbx_row_fetch 3 "5 September 2014" "" OpenDBX
.SH NAME
odbx_row_fetch \- Retrieve rows from the result set
.SH SYNOPSIS
'nh
.nf
\*(T<#include <opendbx/api.h>\*(T>
.fi
.sp 1
.PP
.fi
.ad l
\*(T<int \fBodbx_row_fetch\fR\*(T> \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
\*(T<(odbx_result_t* \fIresult\fR);\*(T>
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
Retrieves the values of a row from the current result set returned by \*(T<\fBodbx_result\fR\*(T>(). Until this function is invoked, no row and field data is available via \*(T<\fBodbx_field_length\fR\*(T>() or \*(T<\fBodbx_field_value\fR\*(T>() and these functions will return zero respectively NULL.
.PP
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 \*(T<\fBodbx_result\fR\*(T>() the next time or the outstanding rows will be returned within the next result.
.PP
\*(T<\fBodbx_row_fetch\fR\*(T>() requires a valid \*(T<result\*(T> object which was created by \*(T<\fBodbx_result\fR\*(T>(). It must not have been feed to \*(T<\fBodbx_result_finish\fR\*(T>() before.
.SH "RETURN VALUE"
\*(T<\fBodbx_row_fetch\fR\*(T>() will return \*(T<ODBX_ROW_NEXT\*(T> ("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 \*(T<ODBX_ROW_DONE\*(T> ("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.
.PP
In case of an error, values less than zero are returned encodeing the reason why the error occurred.
.SH ERRORS
.TP 
-\*(T<ODBX_ERR_PARAM\*(T>
The \*(T<result\*(T> parameter is either NULL or the object is invalid. This is usually the case if result has been already feed to \*(T<\fBodbx_result_finish\fR\*(T>().
.SH "SEE ALSO"
\*(T<\fBodbx_column_count\fR\*(T>(), \*(T<\fBodbx_column_name\fR\*(T>(), \*(T<\fBodbx_column_type\fR\*(T>(), \*(T<\fBodbx_error\fR\*(T>(), \*(T<\fBodbx_error_type\fR\*(T>(), \*(T<\fBodbx_field_length\fR\*(T>(), \*(T<\fBodbx_field_value\fR\*(T>(), \*(T<\fBodbx_result\fR\*(T>()