OpenDBX/C API/odbx init - Revision history

85.18.98.155: /* Description */ mysql_basic.c has socket=param->host

2012-09-24T08:46:58Z

‎Description: mysql_basic.c has socket=param->host

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

2009-04-28T21:13:35Z

moved OpenDBX/API/odbx init to OpenDBX/C API/odbx init

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

2007-05-17T15:16:30Z

OpenDBX init moved to OpenDBX/API/odbx init

Nose: /* Description */

2007-05-11T20:48:20Z

‎Description

@@ Line 31: / Line 31: @@
 ; host name string : supported by Firebird/Interbase, MySQL, Oracle and PostgreSQL backends
 ; IP address string : supported by Firebird/Interbase, MySQL, Oracle and PostgreSQL backends
-; absolute path to Unix domain socket : currently supported by the PostgreSQL backend only
+; absolute path to Unix domain socket : currently supported by the PostgreSQL and MySQL backends only
 ; (relative) directory path with trailing slash/backslash : required by SQLite and SQLite3 backends
 ; section name in configuration file : required by MS SQL Server and Sybase ASE backends

@@ Line 2: / Line 2: @@
 '''Allocate per connection data structures'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_init'''(
       odbx_t** '''''handle''''',
@@ Line 58: / Line 58: @@
 * [[OpenDBX/API/odbx_get_option|odbx_get_option]]()
 * [[OpenDBX/API/odbx_set_option|odbx_set_option]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Allocate per connection data structures'''
   int '''odbx_init'''(
-      odbx_t** '''handle''',
+      odbx_t** '''''handle''''',
-      const char* '''backend''',
+      const char* '''''backend''''',
-      const char* '''host''',
+      const char* '''''host''''',
-      const char* '''port''' )
+      const char* '''''port''''' )
 == Description ==
-'''odbx_init()''' allocates and initializes an opaque object required for all further operations within the OpenDBX library used to identify the connection and to maintain per connection information. Depending on the backend it can open a connection to the database server but often this is done not until performing authentication through [[OpenDBX_bind|odbx_bind()]].
+[[OpenDBX/API/odbx_init|odbx_init]]() allocates and initializes an opaque object required for all further operations within the OpenDBX library which is used to identify the connection and to maintain per connection information. Depending on the backend it can open a connection to the database server but often this is done not until performing authentication through [[OpenDBX/API/odbx_bind|odbx_bind]]().
-The pointer of the newly allocated connection object is stored in '''handle''' if '''odbx_init()''' completes successfully. Otherwise, the value of the odbx_t* variable will be undefined and must not be used as input for other functions of the library. The returned connection object should be freed by [[OpenDBX_finish|odbx_finish()]] to avoid memory leaks if it will be no longer used by the application.
+The pointer of the newly allocated connection object is stored in '''''handle''''' if [[OpenDBX/API/odbx_init|odbx_init]]() completes successfully. Otherwise, the value of the '''''handle''''' variable will be undefined and must not be used as input for other functions of the library. The returned connection object must be freed by [[OpenDBX/API/odbx_finish|odbx_finish]]() to avoid memory leaks if it will be no longer used by the application.
-The OpenDBX library provides access to several different database implementations through a single interface and therefore has to know which one of the available backend modules it should use for all operations. The '''backend''' parameter will be used to perform the lookup of the requested module. It has to be a zero-terminated ASCII string with all characters in in lower case. Currently, these backend modules are available:
+The OpenDBX library provides access to several different database implementations through a single interface and therefore has to know which one of the available backend modules it should use for the operations. The '''''backend''''' parameter will be used to perform the lookup of the requested module. It has to be a zero-terminated ASCII string with all characters in in lower case. Currently, these backend modules are available:
 * firebird (Firebird/Interbase)
@@ Line 25: / Line 27: @@
 * sybase (Sybase ASE)
-Connecting to a database server requires at least an identifier to know where the database is located. There are several kinds of identifiers like host names, IP addresses, named pipes, etc. which could be used. One of them can be provided via the '''host''' parameter and it is up to the native database library what it will accept. Most native libraries accept at least host names and IP addresses and also use the provided '''port''' in this case. The available methods for '''host''' are:
+Connecting to a database server requires at least an identifier to know where the database is located. There are several kinds of identifiers like host names, IP addresses, named pipes, etc. which could be used. One of them can be provided via the '''''host''''' parameter and it is up to the native database library what it will accept. Most native libraries accept at least host names and IP addresses and also use the provided '''''port''''' in this case. The available methods for '''''host''''' are:
 ; host name string : supported by Firebird/Interbase, MySQL, Oracle and PostgreSQL backends
 ; IP address string : supported by Firebird/Interbase, MySQL, Oracle and PostgreSQL backends
-; absolute path to Unix domain socket : supported by MySQL (since 1.3.0) and PostgreSQL backends only
+; absolute path to Unix domain socket : currently supported by the PostgreSQL backend only
 ; (relative) directory path with trailing slash/backslash : required by SQLite and SQLite3 backends
-; section name in conf file : required by MS SQL Server and Sybase ASE backends
+; section name in configuration file : required by MS SQL Server and Sybase ASE backends
-Depending on the native database library, it's also possible to use database specific default values for the '''host''' and '''port''' parameters by supplying empty, zero-terminated strings or a NULL value.
+Depending on the native database library, it's also possible to use database specific default values for the '''''host''''' and '''''port''''' parameters by supplying empty, zero-terminated strings or a NULL value.
 == Return value ==
-'''odbx_init()''' 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_init|odbx_init]]() 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_BACKEND : The backend module returned an error because it couldn't setup the necessary structures
-; -ODBX_ERR_PARAM : '''handle''' is NULL and the allocated connection object can't be stored
+; -ODBX_ERR_PARAM : '''''handle''''' is NULL and the allocated connection object can't be stored
 ; -ODBX_ERR_NOMEM : Allocating new memory for the connection object failed
 ; -ODBX_ERR_SIZE : The length of a string exceeded the available buffer size
@@ Line 50: / Line 52: @@
 == See also ==
-* [[OpenDBX_bind]]
+* [[OpenDBX/API/odbx_bind|odbx_bind]]()
-* [[OpenDBX_capabilities]]
+* [[OpenDBX/API/odbx_capabilities|odbx_capabilities]]()
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_finish|odbx_finish]]()
-* [[OpenDBX_finish]]
+* [[OpenDBX/API/odbx_get_option|odbx_get_option]]()
-* [[OpenDBX_get_option]]
+* [[OpenDBX/API/odbx_set_option|odbx_set_option]]()
-* [[OpenDBX_set_option]]
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 29: / Line 29: @@
 ; host name string : supported by Firebird/Interbase, MySQL, Oracle and PostgreSQL backends
 ; IP address string : supported by Firebird/Interbase, MySQL, Oracle and PostgreSQL backends
-; absolute path to Unix domain socket : currently supported by the PostgreSQL backend only
+; absolute path to Unix domain socket : supported by MySQL (since 1.3.0) and PostgreSQL backends only
-; (relative) directory path with trailing slash/backslash : supported by SQLite and SQLite3 backends
+; (relative) directory path with trailing slash/backslash : required by SQLite and SQLite3 backends
-; section name in conf file : supported by MS SQL Server and Sybase ASE backends
+; section name in conf file : required by MS SQL Server and Sybase ASE backends
 Depending on the native database library, it's also possible to use database specific default values for the '''host''' and '''port''' parameters by supplying empty, zero-terminated strings or a NULL value.

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