OpenDBX/C API/odbx unbind - Revision history

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

2009-04-28T21:15:31Z

moved OpenDBX/API/odbx unbind to OpenDBX/C API/odbx unbind

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

2007-05-17T15:18:26Z

OpenDBX unbind moved to OpenDBX/API/odbx unbind

Nose: /* Return value */

2007-05-13T09:30:39Z

‎Return value

Nose: header hierarchy

2007-05-06T16:44:37Z

header hierarchy

@@ Line 2: / Line 2: @@
 '''Disconnects from the database'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_unbind'''(
       odbx_t* '''''handle''''' )
@@ Line 28: / Line 28: @@
 * [[OpenDBX/API/odbx_error|odbx_error]]()
 * [[OpenDBX/API/odbx_finish|odbx_finish]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Disconnects from the database'''
   int '''odbx_unbind'''(
-      odbx_t* '''handle''' )
+      odbx_t* '''''handle''''' )
 == Description ==
-Releases the binding of the connection to the database and user associated by [[OpenDBX_bind|odbx_bind()]] to the supplied connection object. This is useful for switching to a different database or binding to the database with different credentials. It is also possible to set new connection related options before rebinding to the database server. If an open transaction exists while this function is executed in the firebird backend, it will be committed to the database and closed. The behavior of the other backends for open transactions may vary.
+Releases the binding of the connection to the database and user associated by [[OpenDBX/API/odbx_bind|odbx_bind]]() to the supplied connection object. This is useful for switching to a different database or binding to the database with different credentials. It is also possible to set new connection related options before rebinding to the database server. If an open transaction exists while this function is executed in the firebird backend, it will be committed to the database and closed. The behavior of the other backends for open transactions may vary.
-It's necessary to process all result sets returned by the database server before using this function. Otherwise, it might return an error depending on the native database client library and the backend module. This function must be invoked before calling [[OpenDBX_finish|odbx_finish()]] to avoid memory leaks and connections left open which may block resources needed later on.
+It's necessary to process all result sets returned by the database server before using this function. Otherwise, it might return an error depending on the native database client library and the backend module. This function must be invoked before calling [[OpenDBX/API/odbx_finish|odbx_finish]]() to avoid memory leaks and connections left open which may block necessary resources later on.
-The '''handle''' parameter have to be the connection object created and returned by [[OpenDBX_init|odbx_init()]]. It becomes invalid after it was supplied to [[OpenDBX_finish|odbx_finish()]] and '''odbx_unbind()''' will return an error in this case.
+The '''''handle''''' parameter has to be the connection object created and returned by [[OpenDBX/API/odbx_init|odbx_init]](). It becomes invalid after it was supplied to [[OpenDBX/API/odbx_finish|odbx_finish]]() and [[OpenDBX/API/odbx_unbind|odbx_unbind]]() will return an error in this case.
 == Return value ==
-'''odbx_unbind()''' 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_unbind|odbx_unbind]]() 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 : '''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_bind]]
+* [[OpenDBX/API/odbx_bind|odbx_bind]]()
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_finish|odbx_finish]]()
-* [[OpenDBX_finish]]
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 15: / Line 15: @@
 == 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.
+'''odbx_unbind()''' 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 ==

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 6: / Line 5: @@
       odbx_t* '''handle''' )
-= Description =
+== Description ==
 Releases the binding of the connection to the database and user associated by [[OpenDBX_bind|odbx_bind()]] to the supplied connection object. This is useful for switching to a different database or binding to the database with different credentials. It is also possible to set new connection related options before rebinding to the database server. If an open transaction exists while this function is executed in the firebird backend, it will be committed to the database and closed. The behavior of the other backends for open transactions may vary.
@@ Line 14: / Line 13: @@
 The '''handle''' parameter have to be the connection object created and returned by [[OpenDBX_init|odbx_init()]]. It becomes invalid after it was supplied to [[OpenDBX_finish|odbx_finish()]] and '''odbx_unbind()''' will return an error in this case.
-= Return 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.
-= Errors =
+== Errors ==
 ; -ODBX_ERR_PARAM : '''handle''' is NULL or the supplied connection object is invalid
-= 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)