1odbx_column_name(3)                 OpenDBX                odbx_column_name(3)
2
3
4

NAME

6       odbx_column_name - Get the name of a column in the current result set
7

SYNOPSIS

9       #include <opendbx/api.h>
10
11
12       char* odbx_column_name (odbx_result_t* result, unsigned long pos);
13

DESCRIPTION

15       odbx_column_name()  gets the name of the column specified by pos in the
16       current result set returned by odbx_result(). The column names will not
17       change  within the result set with the exception described for MySQL in
18       odbx_column_count() when the first result  set  wasn't  retrieved  com‐
19       pletely before odbx_result() was called again.
20
21       The  result  parameter required by this function must be a valid result
22       set returned by odbx_result() and must not have been feed  to  odbx_re‐
23       sult_finish() before.
24
25       Valid  column  indices  for the requested column provided via pos start
26       with zero and end with the value returned by odbx_column_count()  minus
27       one.
28

RETURN VALUE

30       The return value of odbx_column_name() is a pointer to a zero terminat‐
31       ed string which consists of the name  of  the  requested  column.  This
32       pointer  is  allocated  by  the database client library and must not be
33       freed by the application. The content of the string may be  overwritten
34       by the next call to odbx_column_name()
35

ERRORS

37       Errors can occur if the given result parameter is NULL or invalid or if
38       the value of pos is out of range, i.e.  more  than  odbx_column_count()
39       minus one.
40

SEE ALSO

42       odbx_column_count(), odbx_column_type(), odbx_result()
43
44
45
46                                22 August 2021             odbx_column_name(3)
Impressum