odbx_field_value(3)

NAME

odbx_field_value - Returns the data stored in a field

SYNOPSIS

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

FCconst char* odbx_field_valueF[0] FC(odbx_result_t* result, unsigned long pos);F[0]

DESCRIPTION

FCodbx_field_valueF[0]() returns a pointer to the field data specified by the column index FCposF[0]. The field is part of the current row which was retrieved by the latest call to FCodbx_row_fetchF[0]().

All values except binary objects are handed back as strings terminated by the zero character. This does also apply to numeric values, dates, etc. They have to be converted to their binary machine dependent representation before arithmetic operations can be done. If a value is undefined, i.e. "NULL" is attached to the field in the database, an equivalent NULL pointer is returned.

The FCresultF[0] parameter required by this function must be a valid result set returned by FCodbx_resultF[0]() and must not has 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 function provides the address pointing to the beginning of the field value where the string or binary object is stored in memory to the caller. It returns a NULL pointer if the field is a "NULL" value.

ERRORS

This function will also return zero if the FCresultF[0] parameter is invalid or if the value of FCposF[0] is out of range.