Difference between revisions of "OpenDBX/C API/odbx field value"

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
(Description:)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
  char* odbx_field_value(
+
  const char* odbx_field_value(
 
     odbx_result_t* result,
 
     odbx_result_t* result,
 
     unsigned long pos )
 
     unsigned long pos )
Line 16: Line 16:
 
= Return values: =
 
= Return values: =
  
* String value or binary object of the specified field
+
* Address of a string or binary object for the specified field. Is NULL if the field is a NULL value or pos is out of range.
  
 
= Errors: =
 
= Errors: =

Revision as of 15:57, 6 May 2006


const char* odbx_field_value(
    odbx_result_t* result,
    unsigned long pos )

Description:

Returns the field value specified by "pos" of the current row. The value of "pos" must be in the range from 0 to odbx_column_count()-1. All values except binary objects are returned as \0 terminated strings but NULL is also a valid field value. Numbers have to be converted to their binary representation before arithmetic operations are allowed.

Parameters:

  • result: Object created by odbx_result()
  • pos: Column number in the current result set

Return values:

  • Address of a string or binary object for the specified field. Is NULL if the field is a NULL value or pos is out of range.

Errors:

  • None



Back to Overview