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

2009-04-28T21:09:06Z

moved OpenDBX/API/odbx bind to OpenDBX/C API/odbx bind

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

: docbook2x update

2008-05-23T22:32:21Z

docbook2x update

Nose: 1 revision(s)

2008-05-23T22:32:21Z

1 revision(s)

84.188.200.68: /* Return value */ Wrong function name?

2007-09-06T08:28:59Z

‎Return value: Wrong function name?

Nose: 1 revision(s)

2007-05-19T20:08:36Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

@@ Line 2: / Line 2: @@
 '''User authentication for a database connection'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_bind'''(
       odbx_t* '''''handle''''',
@@ Line 10: / Line 10: @@
       const char* '''''cred''''',
       int '''''method''''' )
-−
   int '''odbx_bind_simple'''(
       odbx_t* '''''handle''''',
@@ Line 33: / Line 33: @@
 == Return value ==
-[[OpenDBX/API/odbx_bind|odbx_bind]]() 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.
+[[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 ==
@@ Line 50: / Line 50: @@
 * [[OpenDBX/API/odbx_query|odbx_query]]()
 * [[OpenDBX/API/odbx_unbind|odbx_unbind]]()

@@ Line 33: / Line 33: @@
 == Return value ==
-[[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.
+[[OpenDBX/API/odbx_bind|odbx_bind]]() 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 ==

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''User authentication for a database connection'''
   int '''odbx_bind'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      const char* '''database''',
+      const char* '''''database''''',
-      const char* '''who''',
+      const char* '''''who''''',
-      const char* '''cred''',
+      const char* '''''cred''''',
-      int '''method''' )
+      int '''''method''''' )
   int '''odbx_bind_simple'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      const char* '''database''',
+      const char* '''''database''''',
-      const char* '''who''',
+      const char* '''''who''''',
-      const char* '''cred''' )
+      const char* '''''cred''''' )
 == Description ==
-'''odbx_bind()''' associates a connection created by [[OpenDBX_init|odbx_init()]] to a specific database instance after the server verified and accepted the authentication details. All further operations will (normally) only affect the tables and records within this database instance. They may be limited to certain subset depending on the privileges granted to the given user account. If binding to the database instance succeeded, '''odbx_bind()''' also enables compatibility to the ANSI SQL standard if this is possible for the database server implementation.
+[[OpenDBX/API/odbx_bind|odbx_bind]]() associates a connection created by [[OpenDBX/API/odbx_init|odbx_init]]() to a specific database after the server verified and accepted the user credentials. All further operations will (normally) only affect the tables and records within this database. The operations may be limited to certain subset depending on the privileges granted to the given user account. If binding to the database instance succeeded, [[OpenDBX/API/odbx_bind|odbx_bind]]() also enables compatibility to the ANSI SQL standard if this is possible for the database server implementation.
-'''odbx_bind_simple()''' performs the same tasks as '''odbx_bind()''' but can't do anything else than simple user name / password authentication. It shouldn't be used in applications linking to the OpenDBX library version 1.1.1 or later and it will be removed from the library at a later stage.
+[[OpenDBX/API/odbx_bind_simple|odbx_bind_simple]]() performs the same tasks as [[OpenDBX/API/odbx_bind|odbx_bind]]() but can't do anything else than simple user name / password authentication. It shouldn't be used in applications linking to the OpenDBX library version 1.1.1 or later and it will be removed from the library at a later stage.
-Both functions accept almost the same parameters. The '''handle''' parameter always has to be a pointer to a valid connection object allocated by [[OpenDBX_init|odbx_init()]]. The availability of certain options or the behavior of the connection associated to the given connection reference can be changed by calling [[OpenDBX_get_option|odbx_get_option()]] respectively [[OpenDBX_set_option|odbx_set_option()]] but this must be done before calling '''odbx_bind()'''. Examples of such options are the thread-safetiness of the native database client library or to enable support for sending multiple statements at once.
+Both functions accept almost the same parameters. The '''''handle''''' parameter always has to be a pointer to a valid connection object allocated by [[OpenDBX/API/odbx_init|odbx_init]](). The availability of certain options or the behavior of the connection associated to the given odbx_t pointer can be queried by calling [[OpenDBX/API/odbx_get_option|odbx_get_option]]() respectively changed by [[OpenDBX/API/odbx_set_option|odbx_set_option]](). Changes must be done before calling [[OpenDBX/API/odbx_bind|odbx_bind]]() to take any effect. Examples of options are the thread-safetiness of the native database client library or the support for sending multiple statements at once.
-'''database''' is necessary to let the database server know which database instance should be used for executing all further requests. In combination with the authentication parameters '''who''' and '''cred''', it usually allows or denies operations on tables and records within this database instance. Contrary to that, SQLite doesn't use '''who''' and '''cred''' but instead relies on the file system permissions to grant access to the whole database file. If they are used, the supplied values for all three parameters must be zero-terminated strings and should be in exactly the same character case as stored by the database manager. Otherwise, they can also be NULL. Some database libraries also support the use of default values provided by a configuration file if a parameter is NULL.
+'''''database''''' is necessary to let the database server know which database should be used for executing all further requests. In combination with the authentication parameters '''''who''''' and '''''cred''''', it usually allows or denies operations on tables and records within this database. Contrary to that, SQLite doesn't use '''''who''''' and '''''cred''''' but relies on the file system permissions instead to grant access to the whole database file. If they are used, the supplied values for all three parameters must be zero-terminated strings and should be in exactly the same character case as stored by the database manager. Otherwise, if they are unused they can also be NULL. Some database libraries also support default values provided by a configuration file if a parameter is NULL.
-'''method''' specifies the mechanism for authenticating a user account before it can perform operations on tables and records. Currently, all database backend modules only support the ODBX_BIND_SIMPLE method which provides basic user name / password authentication. In this case, the parameter '''who''' must be the name of an user account while '''cred''' has to be the password that belongs to the given account.
+'''''method''''' specifies the mechanism for authenticating a user account before it can perform operations on tables and records. Currently, all database backend modules only support the ODBX_BIND_SIMPLE method which provides basic user name / password authentication. In this case, the parameter '''''who''''' must be the name of an user account while '''''cred''''' has to be the password that belongs to the given account.
-An already associated connection object can be detached from the database and rebound to the same database server. It is possible to bind it to another database instance, with another user account and other options by detaching the connection object with [[OpenDBX_unbind|odbx_unbind()]] first before invoking '''odbx_bind()''' with the same or with different parameters again.
+An already associated connection object can be detached from the database and rebound to the same database server. It is possible to bind it to another database, with another user account and other options set by detaching the connection object with [[OpenDBX/API/odbx_unbind|odbx_unbind]]() first before invoking [[OpenDBX/API/odbx_bind|odbx_bind]]() with the same or with different parameters again.
 == 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 ==
@@ Line 43: / Line 45: @@
 == See also ==
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
-* [[OpenDBX_escape]]
+* [[OpenDBX/API/odbx_init|odbx_init]]()
-* [[OpenDBX_query]]
+* [[OpenDBX/API/odbx_query|odbx_query]]()
-* [[OpenDBX_unbind]]
+* [[OpenDBX/API/odbx_unbind|odbx_unbind]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

← 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 22:32, 23 May 2008
(No difference)

← Older revision	Revision as of 20:08, 19 May 2007
(No difference)

OpenDBX/C API/odbx bind - Revision history

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

Nose: 1 revision(s)

: docbook2x update

Nose: 1 revision(s)

: docbook2x update

: docbook2x update

Nose: 1 revision(s)

84.188.200.68: /* Return value */ Wrong function name?

Nose: 1 revision(s)

: docbook2x update