OpenDBX/C API/odbx finish - Revision history

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

2009-04-28T21:13:03Z

moved OpenDBX/API/odbx finish to OpenDBX/C API/odbx finish

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

2007-05-17T15:15:59Z

OpenDBX finish moved to OpenDBX/API/odbx finish

Nose: header hierarchy

2007-05-06T16:39:02Z

header hierarchy

Nose: description

2007-02-19T20:54:35Z

description

@@ Line 2: / Line 2: @@
 '''Frees connection resources'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_finish'''(
       odbx_t* '''''handle''''' )
@@ Line 27: / Line 27: @@
 * [[OpenDBX/API/odbx_init|odbx_init]]()
 * [[OpenDBX/API/odbx_unbind|odbx_unbind]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Frees connection resources'''
   int '''odbx_finish'''(
-      odbx_t* '''handle''' )
+      odbx_t* '''''handle''''' )
 == Description ==
-'''odbx_finish()''' is responsible for freeing all resources allocated by [[OpenDBX_init|odbx_init()]] and finally may shut down the connection to the database server. It must not be invoked before calling [[OpenDBX_unbind|odbx_unbind()]] to avoid memory leaks and open connection descriptors on the client and server side which may block required resources later on.
+[[OpenDBX/API/odbx_finish|odbx_finish]]() is responsible for freeing all resources allocated by [[OpenDBX/API/odbx_init|odbx_init]]() and finally may shut down the connection to the database server. It must not be invoked before calling [[OpenDBX/API/odbx_unbind|odbx_unbind]]() to avoid memory leaks and open connection descriptors on the client and server side 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 '''odbx_finish()''' for the first time and the function will return an error for all further invocations.
+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]]() for the first time and the function will return an error for all further invocations.
-== Return values ==
+== Return value ==
-'''odbx_finish()''' returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if '''handle''' is invalid or one of the operations couldn't be completed successfully by the backend module. 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_finish|odbx_finish]]() returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if '''''handle''''' is invalid or one of the operations couldn't be completed successfully by the backend module. 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_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
-* [[OpenDBX_init]]
+* [[OpenDBX/API/odbx_init|odbx_init]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 6: / Line 5: @@
       odbx_t* '''handle''' )
-= Description =
+== Description ==
 '''odbx_finish()''' is responsible for freeing all resources allocated by [[OpenDBX_init|odbx_init()]] and finally may shut down the connection to the database server. It must not be invoked before calling [[OpenDBX_unbind|odbx_unbind()]] to avoid memory leaks and open connection descriptors on the client and server side which may block required resources later on.
@@ Line 12: / Line 11: @@
 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 '''odbx_finish()''' for the first time and the function will return an error for all further invocations.
-= Return values =
+== Return values ==
 '''odbx_finish()''' returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if '''handle''' is invalid or one of the operations couldn't be completed successfully by the backend module. 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_error]]

@@ Line 8: / Line 8: @@
 = Description =
-Frees all resources allocated by [[OpenDBX_init|odbx_init()]]. Be sure you invoked [[OpenDBX_unbind|odbx_unbind()]] before to avoid memory leaks.
+'''odbx_finish()''' is responsible for freeing all resources allocated by [[OpenDBX_init|odbx_init()]] and finally may shut down the connection to the database server. It must not be invoked before calling [[OpenDBX_unbind|odbx_unbind()]] to avoid memory leaks and open connection descriptors on the client and server side which may block required resources later on.
-= Parameters =
+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 '''odbx_finish()''' for the first time and the function will return an error for all further invocations.
-−
-* handle: Connection object created by [[OpenDBX_init|odbx_init()]]
 = Return values =

← 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:15, 17 May 2007
(No difference)