OpenDBX/C API/odbx error - Revision history

Nose: moved OpenDBX/API/odbx error to OpenDBX/C API/odbx error

2009-04-28T21:11:16Z

moved OpenDBX/API/odbx error to OpenDBX/C API/odbx error

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

84.188.137.157: Fixed return code.

2007-09-10T16:22:11Z

Fixed return code.

Nose: 1 revision(s)

2007-05-19T20:08:36Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

Nose: OpenDBX error moved to OpenDBX/API/odbx error

2007-05-17T15:14:23Z

OpenDBX error moved to OpenDBX/API/odbx error

Nose: header hierarchy

2007-05-06T16:35:21Z

header hierarchy

@@ Line 2: / Line 2: @@
 '''Returns a human readable error message'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
-  const char* '''odbx_error'''(
+  char* '''odbx_error'''(
       odbx_t* '''''handle''''',
       int '''''error''''' )
@@ Line 28: / Line 28: @@
 * [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 * [[OpenDBX/API/odbx_init|odbx_init]]()

@@ Line 4: / Line 4: @@
   #include <odbx.h>
-  char* '''odbx_error'''(
+  const char* '''odbx_error'''(
       odbx_t* '''''handle''''',
       int '''''error''''' )
@@ Line 28: / Line 28: @@
 * [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 * [[OpenDBX/API/odbx_init|odbx_init]]()
 ----
 Back to [[OpenDBX/API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Returns a human readable error message'''
-  const char* '''odbx_error'''(
+  char* '''odbx_error'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      int '''error''' )
+      int '''''error''''' )
 == Description ==
-'''odbx_error()''' returns an error string corresponding to the supplied error number or the error string generated by the client libraries. Error strings originating from the backend modules or the native database client libraries are cleared as soon as the next odbx_*() function is called. All error strings are statically allocated and must not be changed or freed. If the OpenDBX library is compiled with native language support and the user environment variables are set accordingly to a supported language, strings which are part of the OpenDBX library are translated before being returned. This may also be the case for strings returned by the native database libraries but depends on their support.
+[[OpenDBX/API/odbx_error|odbx_error]]() returns an error string corresponding to the supplied error code or the error string generated by the native database library. Error strings originating from the backend modules or the native database client libraries are cleared as soon as the next odbx_*() function is called. All error strings are statically allocated and must not be changed or freed. If the OpenDBX library is compiled with native language support and the user environment variables are set accordingly to a supported language, strings which are part of the OpenDBX library are translated before being returned. This may also be the case for strings returned by the native database libraries but depends on their support.
-The first parameter '''handle''' is the connection object created and returned by [[OpenDBX_init|odbx_init()]] which becomes invalid as soon as it was supplied to [[OpenDBX_finish|odbx_finish()]]. Anyhow, it isn't necessary to supply a valid handle for errors which use error codes not equal to -ODBX_ERR_BACKEND because they are returned directly from a static error message array. Therefore, it's possible to use '''odbx_error()''' even if [[OpenDBX_init|odbx_init()]] wasn't successful. If -ODBX_ERR_BACKEND is supplied in this case nevertheless, the return error string will be the same as for an invalid handle.
+The first parameter '''''handle''''' is the connection object created and returned by [[OpenDBX/API/odbx_init|odbx_init]]() which becomes invalid as soon as it was supplied to [[OpenDBX/API/odbx_finish|odbx_finish]](). Anyhow, it isn't necessary to supply a valid handle for errors which use error codes not equal to -ODBX_ERR_BACKEND because they are returned directly from a static error message array. Therefore, it's possible to use [[OpenDBX/API/odbx_error|odbx_error]]() even if [[OpenDBX/API/odbx_init|odbx_init]]() wasn't successful. If -ODBX_ERR_BACKEND is supplied in this case nevertheless, the return error string will be the same as for an invalid handle.
-Almost all OpenDBX library functions return an '''error''' code if one of the operations couldn't be completed successfully. The codes returned use values less than zero to indicate different kind of errors and these values can be directly passed to '''odbx_error()''' to obtain the corresponding zero-terminated error string.
+Almost all OpenDBX library functions return an '''''error''''' code if one of the operations couldn't be completed successfully. The codes returned use values less than zero to indicate different kind of errors and these values can be directly passed to [[OpenDBX/API/odbx_error|odbx_error]]() to obtain the corresponding zero-terminated error string.
 == Return value ==
-'''odbx_error()''' returns a zero-terminated string suitable for being displayed to the user of the application.
+[[OpenDBX/API/odbx_error|odbx_error]]() returns a zero-terminated string suitable for being displayed to the user of the application.
 == Errors ==
-If an backend error occurred and '''handle''' is NULL or the supplied connection object is invalid, '''odbx_error()''' returns the localized string for -ODBX_ERR_PARAM.
+If an backend error occurred and '''''handle''''' is NULL or the supplied connection object is invalid, [[OpenDBX/API/odbx_error|odbx_error]]() returns the localized string for -ODBX_ERR_PARAM.
 == See also ==
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 7: / Line 6: @@
       int '''error''' )
-= Description =
+== Description ==
 '''odbx_error()''' returns an error string corresponding to the supplied error number or the error string generated by the client libraries. Error strings originating from the backend modules or the native database client libraries are cleared as soon as the next odbx_*() function is called. All error strings are statically allocated and must not be changed or freed. If the OpenDBX library is compiled with native language support and the user environment variables are set accordingly to a supported language, strings which are part of the OpenDBX library are translated before being returned. This may also be the case for strings returned by the native database libraries but depends on their support.
@@ Line 15: / Line 14: @@
 Almost all OpenDBX library functions return an '''error''' code if one of the operations couldn't be completed successfully. The codes returned use values less than zero to indicate different kind of errors and these values can be directly passed to '''odbx_error()''' to obtain the corresponding zero-terminated error string.
-= Return value =
+== Return value ==
 '''odbx_error()''' returns a zero-terminated string suitable for being displayed to the user of the application.
-= Errors =
+== Errors ==
 If an backend error occurred and '''handle''' is NULL or the supplied connection object is invalid, '''odbx_error()''' returns the localized string for -ODBX_ERR_PARAM.
-= See also =
+== See also ==
 * [[OpenDBX_error_type]]

← Older revision	Revision as of 21:11, 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:14, 17 May 2007
(No difference)