Difference between revisions of "OpenDBX/C API/odbx field length"
(→Errors) |
(header hierarchy) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
'''#include <odbx.h>''' | '''#include <odbx.h>''' | ||
| Line 7: | Line 6: | ||
unsigned long '''pos''' ) | unsigned long '''pos''' ) | ||
| − | = Description = | + | == Description == |
'''odbx_field_length()''' 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 [[OpenDBX row_fetch|odbx_row_fetch()]] and is specified by the column index given by '''pos'''. | '''odbx_field_length()''' 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 [[OpenDBX row_fetch|odbx_row_fetch()]] and is specified by the column index given by '''pos'''. | ||
| Line 15: | Line 14: | ||
Valid column indices for the requested column provided via '''pos''' start with zero and end with the value returned by [[OpenDBX column_count|odbx_column_count()]] minus one. | Valid column indices for the requested column provided via '''pos''' start with zero and end with the value returned by [[OpenDBX column_count|odbx_column_count()]] minus one. | ||
| − | = Return values = | + | == Return values == |
The '''odbx_field_length()''' 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. | The '''odbx_field_length()''' 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 = | + | == Errors == |
This function will also return zero if the '''result''' parameter is invalid or if the value of '''pos''' is out of range. | This function will also return zero if the '''result''' parameter is invalid or if the value of '''pos''' is out of range. | ||
| − | = See also = | + | == See also == |
* [[OpenDBX field_value|odbx_field_value()]] | * [[OpenDBX field_value|odbx_field_value()]] | ||
Revision as of 18:37, 6 May 2007
#include <odbx.h>
unsigned long odbx_field_length(
odbx_result_t* result,
unsigned long pos )
Description
odbx_field_length() 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 odbx_row_fetch() and is specified by the column index given by pos.
The result parameter required by this function must be a valid result set returned by odbx_result() and must not have been feed to odbx_result_free() before.
Valid column indices for the requested column provided via pos start with zero and end with the value returned by odbx_column_count() minus one.
Return values
The odbx_field_length() 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 result parameter is invalid or if the value of pos is out of range.
See also
Back to Overview
