1odbx_row_fetch(3)                   OpenDBX                  odbx_row_fetch(3)
2
3
4

NAME

6       odbx_row_fetch - Retrieve rows from the result set
7

SYNOPSIS

9       #include <opendbx/api.h>
10
11
12       int odbx_row_fetch (odbx_result_t* result);
13

DESCRIPTION

15       Retrieves  the  values of a row from the current result set returned by
16       odbx_result(). Until this function is invoked, no row and field data is
17       available via odbx_field_length() or odbx_field_value() and these func‐
18       tions will return zero respectively NULL.
19
20       Moreover, it is necessary to fetch all rows from a result set until ze‐
21       ro  is returned indicating that no more rows are available. Otherwise -
22       depending on the backend - an error may occur  after  calling  odbx_re‐
23       sult()  the  next  time or the outstanding rows will be returned within
24       the next result.
25
26       odbx_row_fetch() requires a valid result object which  was  created  by
27       odbx_result().  It  must not have been feed to odbx_result_finish() be‐
28       fore.
29

RETURN VALUE

31       odbx_row_fetch() will return ODBX_ROW_NEXT ("1") as long  as  rows  are
32       available  from the result set. After the last row has been made avail‐
33       able, further calls to this function will  return  ODBX_ROW_DONE  ("0")
34       indicating  that  the  result  set doesn't contain more rows. The named
35       constants are available since OpenDBX 1.3.2 and the numbers in brackets
36       have  to  be used instead if a previous release is is the basis for the
37       application development.
38
39       In case of an error, values less than zero are returned  encodeing  the
40       reason why the error occurred.
41

ERRORS

43       -ODBX_ERR_PARAM
44              The  result  parameter  is either NULL or the object is invalid.
45              This is usually the case if result  has  been  already  feed  to
46              odbx_result_finish().
47

SEE ALSO

49       odbx_column_count(),  odbx_column_name(),  odbx_column_type(), odbx_er‐
50       ror(),  odbx_error_type(),   odbx_field_length(),   odbx_field_value(),
51       odbx_result()
52
53
54
55                                22 August 2021               odbx_row_fetch(3)
Impressum