OpenDBX/C API/odbx set option - Revision history

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

2009-04-28T21:15:15Z

moved OpenDBX/API/odbx set option to OpenDBX/C API/odbx set 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:37Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

Nose: OpenDBX set option moved to OpenDBX/API/odbx set option

2007-05-17T15:18:10Z

OpenDBX set option moved to OpenDBX/API/odbx set option

213.39.221.219: /* Description */

2007-05-13T09:24:24Z

‎Description

Nose: header hierarchy

2007-05-06T16:44:03Z

header hierarchy

@@ Line 2: / Line 2: @@
 '''Change behaviour of the database backend'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_set_option'''(
       odbx_t* '''''handle''''',
@@ Line 41: / Line 41: @@
 * [[OpenDBX/API/odbx_error|odbx_error]]()
 * [[OpenDBX/API/odbx_get_option|odbx_get_option]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Change behaviour of the database backend'''
   int '''odbx_set_option'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      unsigned int '''option''',
+      unsigned int '''''option''''',
-      void* '''value''' )
+      void* '''''value''''' )
 == Description ==
-Changes the value of the specified option in the backend module or the native database library associated to '''handle''' by [[OpenDBX_init|odbx_init()]]. Before trying to set an option, it should be tested with [[OpenDBX_get_option|odbx_get_option()]] first to ensure that it is supported by the backend. Almost all options need to be set before connecting to the database server using [[OpenDBX_bind|odbx_bind()]].
+Changes the value of the specified option in the backend module or the native database library associated to handle by [[OpenDBX/API/odbx_init|odbx_init]](). Before trying to set an option, it should be tested with [[OpenDBX/API/odbx_get_option|odbx_get_option]]() first to ensure that it is supported by the backend. Almost all options need to be set before connecting to the database server using [[OpenDBX/API/odbx_bind|odbx_bind]]() to take any effect.
-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. The available options whose values can be changed are:
+There are several '''''option''''' values defined as named constants in the odbx.h header file. The available options whose values can be changed are:
 ; ODBX_OPT_TLS : Use encryption to transmit all data securely over the network via SSL or TLS. This option can be set to ODBX_TLS_NEVER (the default value) to prevent encrpytion, ODBX_TLS_ALWAYS to enforce encryption and to fail if it can't be used between the client library and the server or ODBX_TLS_TRY to use encryption if possible with the option to fall back to a connection which isn't encrypted.
-; ODBX_OPT_MULTI_STATEMENTS : Enables the database server to accept multiple SQL statements in one query string sent via [[OpenDBX_query|odbx_query()]] if the value of '''value''' is set to ODBX_ENABLE. Although, it might be possible to disable it by setting it to ODBX_DISABLE
+; ODBX_OPT_MULTI_STATEMENTS : Enables the database server to accept multiple statements in one query string sent via [[OpenDBX/API/odbx_query|odbx_query]]() if the value of value is set to ODBX_ENABLE. Although, it might be possible to disable it by setting it to ODBX_DISABLE.
-; 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. If paged results are supported by the backend, passing positive values fill fetch the specified number of records at once from the database server. The value of zero ("0") is special in this case because it asks the backend module to retrieve all records at once
+; 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. If paged results are supported by the backend, passing positive values will fetch the specified number of records at once from the database server. The value of zero ("0") is special in this case because it asks the backend module to retrieve all records at once
-; ODBX_OPT_COMPRESS : Enable compressed network traffic between database client and server. This can lower the latency if the network is the bottleneck. Pass an integer variable with ODBX_ENABLE to enable compression or with ODBX_DISABLE to disable it for this connection
+; ODBX_OPT_COMPRESS : Enable compressed network traffic between database client and server. This can maximize the throughput if the network is the bottleneck. Pass an integer variable with ODBX_ENABLE to enable compression or with ODBX_DISABLE to disable it for this connection
-; 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 point to a zero terminated string and for a detailed description of the MySQL modes look at their [http://dev.mysql.com/doc/refman/5.0/en/server-sql-mode.html website]
+; 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 point to a zero terminated string and for a detailed description of the MySQL modes look at their [http://dev.mysql.com/doc/refman/5.0/en/server-sql-mode.html website]
-If not stated otherwise, the type of the variable passed to the third parameter '''value''' must be an integer pointer. Its values should be in the range specified by the option being changed.
+If not stated otherwise, the type of the variable passed to the third parameter '''''value''''' must be an integer pointer. Its values should be in the range specified by the option being changed.
-== 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_set_option|odbx_set_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
-; -ODBX_ERR_OPTRO : The option isn't intended for being changed and could only be read via [[OpenDBX_get_option|odbx_get_option()]]
+; -ODBX_ERR_OPTRO : The option isn't intended for being changed and could only be read via [[OpenDBX/API/odbx_get_option|odbx_get_option]]()
-; -ODBX_ERR_OPTWR : Setting the option failed for various reasons. It's most likely that the value passed via '''value''' didn't match the range of values expected by the backend or the native database library
+; -ODBX_ERR_OPTWR : Setting the option failed for various reasons. It's most likely that the value passed via '''''value''''' didn't match the range of values expected by the backend or the native database library
 == See also ==
-* [[OpenDBX_bind]]
+* [[OpenDBX/API/odbx_bind|odbx_bind]]()
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_get_option|odbx_get_option]]()
-* [[OpenDBX_get_option]]
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 16: / Line 16: @@
 ; ODBX_OPT_TLS : Use encryption to transmit all data securely over the network via SSL or TLS. This option can be set to ODBX_TLS_NEVER (the default value) to prevent encrpytion, ODBX_TLS_ALWAYS to enforce encryption and to fail if it can't be used between the client library and the server or ODBX_TLS_TRY to use encryption if possible with the option to fall back to a connection which isn't encrypted.
-; ODBX_OPT_MULTI_STATEMENTS : Enables the database server to accept multiple SQL statements in one query string sent via [[OpenDBX_query|odbx_query()]] if the value of '''value''' is set to one ("1"). Although, it might be possible to disable it by setting it to zero ("0")
+; ODBX_OPT_MULTI_STATEMENTS : Enables the database server to accept multiple SQL statements in one query string sent via [[OpenDBX_query|odbx_query()]] if the value of '''value''' is set to ODBX_ENABLE. Although, it might be possible to disable it by setting it to ODBX_DISABLE
 ; 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. If paged results are supported by the backend, passing positive values fill fetch the specified number of records at once from the database server. The value of zero ("0") is special in this case because it asks the backend module to retrieve all records at once
-; ODBX_OPT_COMPRESS : Enable compressed network traffic between database client and server. This can lower the latency if the network is the bottleneck. Pass an integer variable with one ("1") to enable compression or with zero ("0") to disable it for this connection
+; ODBX_OPT_COMPRESS : Enable compressed network traffic between database client and server. This can lower the latency if the network is the bottleneck. Pass an integer variable with ODBX_ENABLE to enable compression or with ODBX_DISABLE to disable it for this connection
 ; 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 point to a zero terminated string and for a detailed description of the MySQL modes look at their [http://dev.mysql.com/doc/refman/5.0/en/server-sql-mode.html website]

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 8: / Line 7: @@
       void* '''value''' )
-= Description =
+== Description ==
 Changes the value of the specified option in the backend module or the native database library associated to '''handle''' by [[OpenDBX_init|odbx_init()]]. Before trying to set an option, it should be tested with [[OpenDBX_get_option|odbx_get_option()]] first to ensure that it is supported by the backend. Almost all options need to be set before connecting to the database server using [[OpenDBX_bind|odbx_bind()]].
@@ Line 24: / Line 23: @@
 If not stated otherwise, the type of the variable passed to the third parameter '''value''' must be an integer pointer. Its values should be in the range specified by the option being changed.
-= 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
@@ Line 35: / Line 34: @@
 ; -ODBX_ERR_OPTWR : Setting the option failed for various reasons. It's most likely that the value passed via '''value''' didn't match the range of values expected by the backend or the native database library
-= See also =
+== See also ==
 * [[OpenDBX_bind]]

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