OpenDBX/C API/odbx field length - Revision history

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

2009-04-28T21:12:17Z

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

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 length moved to OpenDBX/API/odbx field length

2007-05-17T15:15:21Z

OpenDBX field length moved to OpenDBX/API/odbx field length

Nose: header hierarchy

2007-05-06T16:37:54Z

header hierarchy

Nose: /* Errors */

2007-04-25T19:41:57Z

‎Errors

@@ Line 12: / Line 12: @@
 [[OpenDBX/API/odbx_field_length|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/API/odbx_row_fetch|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 [[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 length of a field value'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   unsigned long '''odbx_field_length'''(
       odbx_result_t* '''''result''''',
@@ Line 28: / Line 28: @@
 * [[OpenDBX/API/odbx_field_value|odbx_field_value]]()
 * [[OpenDBX/API/odbx_result|odbx_result]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Returns the length of a field value'''
   unsigned long '''odbx_field_length'''(
-      odbx_result_t* '''result''',
+      odbx_result_t* '''''result''''',
-      unsigned long '''pos''' )
+      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 [[OpenDBX row_fetch|odbx_row_fetch()]] and is specified by the column index given by '''pos'''.
+[[OpenDBX/API/odbx_field_length|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/API/odbx_row_fetch|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 [[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 '''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 [[OpenDBX/API/odbx_field_length|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.
+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 field_value|odbx_field_value()]]
+* [[OpenDBX/API/odbx_field_value|odbx_field_value]]()
 ----
-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_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.
-= 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.
-= Errors =
+== 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 =
+== See also ==
 * [[OpenDBX field_value|odbx_field_value()]]

@@ Line 21: / Line 21: @@
 = Errors =
-This function will also return zero if the '''result''' parameter is invalid of 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 =

← 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)