odbx_column_name(3)

NAME

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

SYNOPSIS

FC#include <opendbx/api.h>F[0]

FCchar* odbx_column_nameF[0] FC(odbx_result_t* result, unsigned long pos);F[0]

DESCRIPTION

FCodbx_column_nameF[0]() gets the name of the column specified by pos in the current result set returned by FCodbx_resultF[0](). The column names will not change within the result set with the exception described for MySQL in FCodbx_column_countF[0]() when the first result set wasn't retrieved completely before FCodbx_resultF[0]() was called again.

The FCresultF[0] parameter required by this function must be a valid result set returned by FCodbx_resultF[0]() and must not have been feed to FCodbx_result_finishF[0]() before.

Valid column indices for the requested column provided via FCposF[0] start with zero and end with the value returned by FCodbx_column_countF[0]() minus one.

RETURN VALUE

The return value of FCodbx_column_nameF[0]() is a pointer to a zero terminated string which consists of the name of the requested column. This pointer is allocated by the database client library and must not be freed by the application. The content of the string may be overwritten by the next call to FCodbx_column_nameF[0]()

ERRORS

Errors can occur if the given FCresultF[0] parameter is NULL or invalid or if the value of FCposF[0] is out of range, i.e. more than FCodbx_column_countF[0]() minus one.