OpenDBX/C API/odbx get option - Revision history

Nose: moved OpenDBX/API/odbx get option to OpenDBX/C API/odbx get option

2009-04-28T21:13:17Z

moved OpenDBX/API/odbx get option to OpenDBX/C API/odbx get option

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

2007-05-17T15:16:16Z

OpenDBX get option moved to OpenDBX/API/odbx get option

Nose at 19:55, 11 May 2007

2007-05-11T19:55:14Z

Nose: header hierarchy

2007-05-06T16:39:40Z

header hierarchy

@@ Line 2: / Line 2: @@
 '''Query backend for implemented options'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_get_option'''(
       odbx_t* '''''handle''''',
@@ Line 43: / Line 43: @@
 * [[OpenDBX/API/odbx_init|odbx_init]]()
 * [[OpenDBX/API/odbx_set_option|odbx_set_option]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Query backend for implemented options'''
   int '''odbx_get_option'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      unsigned int '''option''',
+      unsigned int '''''option''''',
-      void* '''value''' )
+      void* '''''value''''' )
 == Description ==
-'''odbx_get_option()''' asks the backend module associated to '''handle''' by [[OpenDBX_init|odbx_init()]] for implemented options and their current values. This function can be used at every stage as long as '''handle''' points to a valid connection object. Its primary use is to find out supported features of the backend module and to enable them with [[OpenDBX_set_option|odbx_set_option()]] before the connection to the database server is established by calling [[OpenDBX_bind|odbx_bind()]].
+[[OpenDBX/API/odbx_get_option|odbx_get_option]]() asks the backend module associated to '''''handle''''' by [[OpenDBX/API/odbx_init|odbx_init]]() for implemented options and their current values. This function can be used at every stage as long as '''''handle''''' points to a valid connection object. Its primary use is to find out supported features of the backend module and to enable them with [[OpenDBX/API/odbx_set_option|odbx_set_option]]() before the connection to the database server is established by calling [[OpenDBX/API/odbx_bind|odbx_bind]]().
-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()]].
+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]]().
-There are several options defined as named constants in the '''odbx.h''' header file. A few of them are for informational purpose only while most of the options can also be set to different '''option''' values by [[OpenDBX_set_option|odbx_set_option()]] to change the behavior of the backend module. The available options are:
+There are several '''''option''''' values defined as named constants in the odbx.h header file. A few of them are for informational purpose only while most of the options can also be set to different '''''option''''' values by [[OpenDBX/API/odbx_set_option|odbx_set_option]]() to change the behavior of the backend module. The available options are:
-; ODBX_OPT_API_VERSION : The API version implemented by the backend. Currently, it returns only zero and is reserved for the future.
+; ODBX_OPT_API_VERSION : The API version implemented by the backend. Currently, it returns only zero and is reserved for the future
 ; ODBX_OPT_THREAD_SAFE : If it is safe to use this backend and especially the native database client library in an application which uses threads where more than one thread opens database connections via the OpenDBX library
 ; ODBX_OPT_TLS : The database client library may support transmitting all data securely by encrypting the network traffic via SSL or TLS
-; ODBX_OPT_MULTI_STATEMENTS : The database server may be able to support multiple SQL statements in one query string sent via [[OpenDBX_query|odbx_query()]]
+; ODBX_OPT_MULTI_STATEMENTS : The database server may be able to support multiple SQL statements in one query string sent via [[OpenDBX/API/odbx_query|odbx_query]]()
-; ODBX_OPT_PAGED_RESULTS : All database servers and client libraries are able to transfer the records row by row. Some of them can also transfer multiple rows or even all at once to minimize server load, network traffic and latency. The downside of this is an increased memory consumption.
+; ODBX_OPT_PAGED_RESULTS : All database servers and client libraries are able to transfer the records row by row. Some of them can also transfer multiple rows or even all at once to minimize server load, network traffic and latency. The downside of this is an increased memory consumption
-; ODBX_OPT_COMPRESS : Support of compressed network traffic between database client and server. This can lower the latency if the network is the bottleneck.
+; ODBX_OPT_COMPRESS : Support of compressed network traffic between database client and server. This can lead to higher throughput if the network is the bottleneck
 ; ODBX_OPT_MODE : Some database servers support different modes of operation, e.g. modes for compliance to other SQL implementations or completely different query languages. This option is available since OpenDBX 1.1.4
-'''value''' must be a pointer to an integer variable where the backend module will store the result for the supplied option. If it's not stated otherwise, the value assigned to the '''value''' parameter by '''odbx_get_option()''' will be of boolean nature and therefore is one ("1") for a supported option or zero ("0") for an option which isn't supported.
+'''''value''''' must be a pointer to an integer variable where the backend module will store the result for the supplied option. If it's not stated otherwise, the value assigned to the '''''value''''' parameter by [[OpenDBX/API/odbx_get_option|odbx_get_option]]() will be of boolean nature and therefore is ODBX_ENABLE for a supported option or ODBX_DISABLE for an option which isn't supported.
-== Return values ==
+== Return value ==
-'''odbx_get_option()''' returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. 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_get_option|odbx_get_option]]() returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. 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 : One of the supplied parameters is invalid or is NULL and this isn't allowed in the used backend module or in the native database client library
-; -ODBX_ERR_OPTION : The value passed to the '''option''' parameter isn't one of the values listed in this manual. The content of '''value''' remains unchanged if this error occurs
+; -ODBX_ERR_OPTION : The value passed to the '''''option''''' parameter isn't one of the values listed in this manual. The content of '''''value''''' remains unchanged if this error occurs
 == See also ==
-* [[OpenDBX_bind]]
+* [[OpenDBX/API/odbx_bind|odbx_bind]]()
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
-* [[OpenDBX_set_option]]
+* [[OpenDBX/API/odbx_init|odbx_init]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 13: / Line 13: @@
 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()]].
-There are several '''options''' defined as named constants in the '''odbx.h''' header file. A few of them are for informational purpose only while most of the options can also be set to different values by [[OpenDBX_set_option|odbx_set_option()]] to change the behavior of the backend module. The available options are:
+There are several options defined as named constants in the '''odbx.h''' header file. A few of them are for informational purpose only while most of the options can also be set to different '''option''' values by [[OpenDBX_set_option|odbx_set_option()]] to change the behavior of the backend module. The available options are:
 ; ODBX_OPT_API_VERSION : The API version implemented by the backend. Currently, it returns only zero and is reserved for the future.

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 8: / Line 7: @@
       void* '''value''' )
-= Description =
+== Description ==
 '''odbx_get_option()''' asks the backend module associated to '''handle''' by [[OpenDBX_init|odbx_init()]] for implemented options and their current values. This function can be used at every stage as long as '''handle''' points to a valid connection object. Its primary use is to find out supported features of the backend module and to enable them with [[OpenDBX_set_option|odbx_set_option()]] before the connection to the database server is established by calling [[OpenDBX_bind|odbx_bind()]].
@@ Line 26: / Line 25: @@
 '''value''' must be a pointer to an integer variable where the backend module will store the result for the supplied option. If it's not stated otherwise, the value assigned to the '''value''' parameter by '''odbx_get_option()''' will be of boolean nature and therefore is one ("1") for a supported option or zero ("0") for an option which isn't supported.
-= Return values =
+== Return values ==
 '''odbx_get_option()''' returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. 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 : One of the supplied parameters is invalid or is NULL and this isn't allowed in the used backend module or in the native database client library
 ; -ODBX_ERR_OPTION : The value passed to the '''option''' parameter isn't one of the values listed in this manual. The content of '''value''' remains unchanged if this error occurs
-= See also =
+== See also ==
 * [[OpenDBX_bind]]

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