OpenDBX/C API/odbx field value - Revision history

80.171.102.163: /* Description */

2010-07-06T06:16:10Z

‎Description

Nose: moved OpenDBX/API/odbx field value to OpenDBX/C API/odbx field value

2009-04-28T21:12:46Z

moved OpenDBX/API/odbx field value to OpenDBX/C API/odbx field value

Nose: 1 revision(s)

2008-05-23T22:49:54Z

1 revision(s)

: docbook2x update

2008-05-23T22:49:54Z

docbook2x update

Nose: 1 revision(s)

2008-05-23T22:33:26Z

1 revision(s)

: docbook2x update

2008-05-23T22:33:26Z

docbook2x update

Nose: 1 revision(s)

2007-05-19T20:08:36Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

Nose: OpenDBX field value moved to OpenDBX/API/odbx field value

2007-05-17T15:15:39Z

OpenDBX field value moved to OpenDBX/API/odbx field value

Nose: header hierarchy

2007-05-06T16:38:29Z

header hierarchy

@@ Line 12: / Line 12: @@
 [[OpenDBX/API/odbx_field_value|odbx_field_value]]() returns a pointer to the field data specified by the column index '''''pos'''''. The field is part of the current row which was retrieved by the latest call to [[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]().
-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.
+All values except binary objects (and large objects if the ODBC_CAP_LO interface is supported) 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. Backends supporting the large objects interface return a reference to the object that have to be feed into [[OpenDBX/API/odbx_lo_open|odbx_lo_open]]().
 The '''''result''''' parameter required by this function must be a valid result set returned by [[OpenDBX/API/odbx_result|odbx_result]]() and must not has been feed to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() before.

@@ Line 14: / Line 14: @@
 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 '''''result''''' parameter required by this function must be a valid result set returned by [[OpenDBX/API/odbx_result|odbx_result]]() and must not has been feed to [[OpenDBX/API/odbx_result_free|odbx_result_free]]() before.
+The '''''result''''' parameter required by this function must be a valid result set returned by [[OpenDBX/API/odbx_result|odbx_result]]() and must not has been feed to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() before.
 Valid column indices for the requested column provided via '''''pos''''' start with zero and end with the value returned by [[OpenDBX/API/odbx_column_count|odbx_column_count]]() minus one.

@@ Line 2: / Line 2: @@
 '''Returns the data stored in a field'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   const char* '''odbx_field_value'''(
       odbx_result_t* '''''result''''',
@@ Line 31: / Line 31: @@
 * [[OpenDBX/API/odbx_field_length|odbx_field_length]]()
 * [[OpenDBX/API/odbx_result|odbx_result]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Returns the data stored in a field'''
   const char* '''odbx_field_value'''(
-      odbx_result_t* '''result''',
+      odbx_result_t* '''''result''''',
-      unsigned long '''pos''' )
+      unsigned long '''''pos''''' )
 == Description ==
-'''odbx_field_value()''' returns a pointer to the field value specified by the column index '''pos'''. The field is part of the current row which was retrieved by the latest call to [[OpenDBX row_fetch|odbx_row_fetch()]].
+[[OpenDBX/API/odbx_field_value|odbx_field_value]]() returns a pointer to the field data specified by the column index '''''pos'''''. The field is part of the current row which was retrieved by the latest call to [[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]]().
 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 '''result''' parameter required by this function must be a valid result set returned by [[OpenDBX result|odbx_result()]] and must not have been feed to [[OpenDBX result_free|odbx_result_free()]] before.
+The '''''result''''' parameter required by this function must be a valid result set returned by [[OpenDBX/API/odbx_result|odbx_result]]() and must not has been feed to [[OpenDBX/API/odbx_result_free|odbx_result_free]]() before.
-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/API/odbx_column_count|odbx_column_count]]() minus one.
-== Return values ==
+== Return value ==
-The function provides the address of the field value pointing to its beginning back to the caller where the string or binary object is stored in memory. It returns a NULL pointer if the field is a "NULL" 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 NULL 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 ==
-* [[OpenDBX column_type|odbx_column_type()]]
+* [[OpenDBX/API/odbx_column_type|odbx_column_type]]()
-* [[OpenDBX field_length|odbx_field_length()]]
+* [[OpenDBX/API/odbx_field_length|odbx_field_length]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 7: / Line 6: @@
       unsigned long '''pos''' )
-= Description =
+== Description ==
 '''odbx_field_value()''' returns a pointer to the field value specified by the column index '''pos'''. The field is part of the current row which was retrieved by the latest call to [[OpenDBX row_fetch|odbx_row_fetch()]].
@@ Line 17: / Line 16: @@
 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 function provides the address of the field value pointing to its beginning back to the caller where the string or binary object is stored in memory. It returns a NULL pointer if the field is a "NULL" value.
-= Errors =
+== Errors ==
 This function will also return NULL if the '''result''' parameter is invalid or if the value of '''pos''' is out of range.
-= See also =
+== See also ==
 * [[OpenDBX column_type|odbx_column_type()]]

← Older revision	Revision as of 21:12, 28 April 2009
(No difference)

← Older revision	Revision as of 22:49, 23 May 2008
(No difference)

← Older revision	Revision as of 22:33, 23 May 2008
(No difference)

← Older revision	Revision as of 20:08, 19 May 2007
(No difference)

← Older revision	Revision as of 15:15, 17 May 2007
(No difference)