OpenDBX/C API/odbx capabilities - Revision history

80.171.102.163: /* Description */

2010-07-06T06:11:12Z

‎Description

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

2009-04-28T21:09:43Z

moved OpenDBX/API/odbx capabilities to OpenDBX/C API/odbx capabilities

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:25Z

1 revision(s)

: docbook2x update

2008-05-23T22:33:25Z

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

2007-05-17T15:12:55Z

OpenDBX capabilities moved to OpenDBX/API/odbx capabilities

Nose: header hierarchy

2007-05-06T16:31:50Z

header hierarchy

@@ Line 16: / Line 16: @@
 '''''cap''''' is the number of the capability set as defined by macro constants in odbx.h. Valid constant names which can be supplied as second parameter to [[OpenDBX/API/odbx_capabilities|odbx_capabilities]]() are listed below:
-; -ODBX_CAP_BASIC : The core function set which have to be implemented by all backends. It consists of all functions necessary to connect to, send textual queries to and process simple results returned from the database server as well as error handling functions.
+; ODBX_CAP_BASIC : The core function set which have to be implemented by all backends. It consists of all functions necessary to connect to, send textual queries to and process simple results returned from the database server as well as error handling functions.
 == Return value ==

@@ Line 2: / Line 2: @@
 '''Query implemented capabilities'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_capabilities'''(
       odbx_t* '''''handle''''',
@@ Line 31: / Line 31: @@
 * [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 * [[OpenDBX/API/odbx_init|odbx_init]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Query implemented capabilities'''
   int '''odbx_capabilities'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      unsigned int '''cap''' )
+      unsigned int '''''cap''''' )
 == Description ==
-'''odbx_capabilites()''' ask the backend associated to the connection object returned by [[OpenDBX_init|odbx_init()]] if a certain capability set is implemented by this backend. All backends have to implement the basic capability set and may implement further predefined functional sets if they are supported by the native database client library. This function can be called at any stage after [[OpenDBX_init|odbx_init()]] returned successfully.
+[[OpenDBX/API/odbx_capabilities|odbx_capabilities]]() ask the backend associated to the connection object returned by [[OpenDBX/API/odbx_init|odbx_init]]() if a certain capability set is implemented by this backend. All backends have to implement the basic capability set and may implement further predefined functional sets if they are supported by the native database client library. This function can be called at any stage after [[OpenDBX/API/odbx_init|odbx_init]]() returned successfully.
-The first parameter '''handle''' have to be the connection object created and returned by [[OpenDBX_init|odbx_init()]]. It becomes invalid as soon as it was supplied to [[OpenDBX_finish|odbx_finish()]] and '''odbx_capabilities()''' will return an error in this case.
+The first parameter '''''handle''''' has to be the connection object created and returned by [[OpenDBX/API/odbx_init|odbx_init]](). It becomes invalid as soon as it was supplied to [[OpenDBX/API/odbx_finish|odbx_finish]]() and [[OpenDBX/API/odbx_capabilities|odbx_capabilities]]() will return an error in this case.
-'''cap''' is the number of the capability set as defined by macro constants in '''odbx.h'''. Valid constant names which can be supplied as second parameter to '''odbx_capabilities()''' are listed below:
+'''''cap''''' is the number of the capability set as defined by macro constants in odbx.h. Valid constant names which can be supplied as second parameter to [[OpenDBX/API/odbx_capabilities|odbx_capabilities]]() are listed below:
-; ODBX_CAP_BASIC : The core function set which have to be implemented by all backends. It consists of all functions necessary to connect to, send textual queries to and process simple results returned from the database server as well as error handling functions.
+; -ODBX_CAP_BASIC : The core function set which have to be implemented by all backends. It consists of all functions necessary to connect to, send textual queries to and process simple results returned from the database server as well as error handling functions.
 == Return value ==
-'''odbx_capabilities()''' returns one ("1") if the requested capability is supported, zero ("0") if the capability is not supported or an error code whose value is less than zero if one of the supplied parameters is invalid. Possible error codes are listed in the error section and they can be feed to [[OpenDBX_error|odbx_error()]] and [[OpenDBX_error_type|odbx_error_type()]] to get further details.
+[[OpenDBX/API/odbx_capabilities|odbx_capabilities]]() returns ODBX_ENABLE if the requested capability is supported, ODBX_DISABLE if the capability is not supported or an error code whose value is less than zero if one of the supplied parameters is invalid. Possible error codes are listed in the error section and they can be feed to [[OpenDBX/API/odbx_error|odbx_error]]() and [[OpenDBX/API/odbx_error_type|odbx_error_type]]() to get further details.
 == Errors ==
-; -ODBX_ERR_PARAM : '''handle''' is NULL or the supplied connection object is invalid
+; -ODBX_ERR_PARAM : '''''handle''''' is NULL or the supplied connection object is invalid
 == See also ==
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[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: @@
       unsigned int '''cap''' )
-= Description =
+== Description ==
 '''odbx_capabilites()''' ask the backend associated to the connection object returned by [[OpenDBX_init|odbx_init()]] if a certain capability set is implemented by this backend. All backends have to implement the basic capability set and may implement further predefined functional sets if they are supported by the native database client library. This function can be called at any stage after [[OpenDBX_init|odbx_init()]] returned successfully.
@@ Line 17: / Line 16: @@
 ; ODBX_CAP_BASIC : The core function set which have to be implemented by all backends. It consists of all functions necessary to connect to, send textual queries to and process simple results returned from the database server as well as error handling functions.
-= Return value =
+== Return value ==
 '''odbx_capabilities()''' returns one ("1") if the requested capability is supported, zero ("0") if the capability is not supported or an error code whose value is less than zero if one of the supplied parameters is invalid. Possible error codes are listed in the error section and they can be feed to [[OpenDBX_error|odbx_error()]] and [[OpenDBX_error_type|odbx_error_type()]] to get further details.
-= Errors =
+== Errors ==
 ; -ODBX_ERR_PARAM : '''handle''' is NULL or the supplied connection object is invalid
-= See also =
+== See also ==
 * [[OpenDBX_error]]

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