OpenDBX/C API/odbx result finish - Revision history

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

2009-04-28T21:14:25Z

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

Nose: 1 revision(s)

2008-05-23T22:49:54Z

1 revision(s)

: docbook2x update

2008-05-23T22:49:54Z

docbook2x update

Nose: /* Return value */

2008-05-23T22:46:37Z

‎Return value

Nose: /* Return value */

2008-05-23T22:46:10Z

‎Return value

Nose: 1 revision(s)

2008-05-23T22:33:26Z

1 revision(s)

: docbook2x update

2008-05-23T22:33:26Z

docbook2x update

New page

__NOTOC__
'''Closes the result set and frees its allocated memory'''

#include <opendbx/api.h>

int '''odbx_result_finish'''(
odbx_result_t* '''''result''''' )

void '''odbx_result_free'''(
odbx_result_t* '''''result''''' )

== Description ==

[[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() closes the result set which may also include dropping the non-fetched rows sent by the server. It releases all resources allocated by [[OpenDBX/API/odbx_result|odbx_result]]() and by the native database library which are attached to '''''result''''' as well as the memory the first parameter is pointing to. Trying to free '''''result''''' manually using free() will create memory leaks because it contains more dynamically allocated structures and also the memory of the result set allocated by the native database library. [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() must be called even if the statement was not a SELECT-like statement which returned now rows as it may be necessary to commit the changes done by the statement.

[[OpenDBX/API/odbx_result_free|odbx_result_free]]() performs the same tasks as [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() but is unable to return an error if the task couln't be completed. It shouldn't be used in applications linking to the OpenDBX library version 1.3.8 or later and it will be removed from the library at a later stage.

'''''result''''' must be valid a result set created by [[OpenDBX/API/odbx_result|odbx_result]]() which is returned via its second parameter. After feeding it to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() it becomes invalid and must not be feed to it again. Otherwise a "double free" may occur and the application may be terminated.

== Return value ==

[[OpenDBX/API/odbx_result_finsih|odbx_result_finsih]]() 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 native database library returned an error
; -ODBX_ERR_PARAM : The '''''result''''' parameter is invalid

== See also ==

* [[OpenDBX/API/odbx_result|odbx_result]]()

@@ Line 20: / Line 20: @@
 == Return value ==
-[[OpenDBX/API/odbx_result_finsih|odbx_result_finish]]() 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_result_finish|odbx_result_finish]]() 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 ==

← Older revision	Revision as of 21:14, 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)