odbx_field_length(3)

NAME

odbx_field_length - Returns the length of a field value

SYNOPSIS

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

FCunsigned long odbx_field_lengthF[0] FC(odbx_result_t* result, unsigned long pos);F[0]

DESCRIPTION

FCodbx_field_lengthF[0]() returns the length of the field value in bytes. The field is part of the current row which was retrieved by the latest call to FCodbx_row_fetchF[0]() and is specified by the column index given by FCposF[0].

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 FCodbx_field_lengthF[0]() function provides the number of bytes of the specified field to the caller. If the field value consists of character data, the returned length will be without the terminating zero character. For binary values the exact size of the block as stored in the database is returned.

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.