OpenDBX/API/odbx result free - Revision history

Nose: 1 revision(s)

2007-05-19T20:08:36Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

Nose: OpenDBX result free moved to OpenDBX/API/odbx result free

2007-05-17T15:17:16Z

OpenDBX result free moved to OpenDBX/API/odbx result free

Nose: header hierarchy

2007-05-06T16:42:18Z

header hierarchy

Nose: rewrite

2007-03-10T13:48:38Z

rewrite

Nose: header

2007-02-14T22:23:23Z

header

Nose: see also

2007-02-13T09:52:06Z

Nose: /* Parameters: */

2006-06-05T15:56:54Z

‎Parameters:

Nose: /* Description: */

2006-06-05T15:56:24Z

‎Description:

Nose: /* Description: */

2005-10-01T18:39:48Z

‎Description:

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Frees the allocated memory of a result set'''
   void '''odbx_result_free'''(
-      odbx_result_t* '''result''' )
+      odbx_result_t* '''''result''''' )
 == Description ==
-'''odbx_result_free()''' releases all resources allocated by [[OpenDBX_result|odbx_result()]] or by the native database library which are attached to '''result'''. It also frees the memory the first parameter is pointing to. Trying to free() '''result''' manually will create memory leaks because it contains more dynamically allocated structures and also the result set allocated by the native database library. '''odbx_result_free()''' must be called even if the statement was not a SELECT-like statement which returned now rows.
+[[OpenDBX/API/odbx_result_free|odbx_result_free]]() releases all resources allocated by [[OpenDBX/API/odbx_result|odbx_result]]() and by the native database library which are attached to result. It also frees 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_free|odbx_result_free]]() must be called even if the statement was not a SELECT-like statement which returned now rows.
-'''result''' must be a result set object created by [[OpenDBX_result|odbx_result()]] which is returned via its second parameter. After feeding it to '''odbx_result_free()''' it becomes invalid and must not be feed to it again. Otherwise a "double free" will occur and the application will be terminated.
+'''''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_free|odbx_result_free]]() it becomes invalid and must not be feed to it again. Otherwise a "double free" will occur and the application may be terminated.
-== Return values ==
+== Return value ==
 This function doesn't return any values.
@@ Line 17: / Line 19: @@
 == Errors ==
-'''odbx_result_free()''' tries its best to cleanup the allocated structure and doesn't generate an error.
+[[OpenDBX/API/odbx_result_free|odbx_result_free]]() tries its best to cleanup the allocated structure and doesn't generate an error.
 == See also ==
-[[OpenDBX_result|odbx_result()]]
+* [[OpenDBX/API/odbx_result|odbx_result]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
   '''#include <odbx.h>'''
@@ Line 6: / Line 5: @@
       odbx_result_t* '''result''' )
-= Description =
+== Description ==
 '''odbx_result_free()''' releases all resources allocated by [[OpenDBX_result|odbx_result()]] or by the native database library which are attached to '''result'''. It also frees the memory the first parameter is pointing to. Trying to free() '''result''' manually will create memory leaks because it contains more dynamically allocated structures and also the result set allocated by the native database library. '''odbx_result_free()''' must be called even if the statement was not a SELECT-like statement which returned now rows.
@@ Line 12: / Line 11: @@
 '''result''' must be a result set object created by [[OpenDBX_result|odbx_result()]] which is returned via its second parameter. After feeding it to '''odbx_result_free()''' it becomes invalid and must not be feed to it again. Otherwise a "double free" will occur and the application will be terminated.
-= Return values =
+== Return values ==
 This function doesn't return any values.
-= Errors =
+== Errors ==
 '''odbx_result_free()''' tries its best to cleanup the allocated structure and doesn't generate an error.
-= See also =
+== See also ==
 [[OpenDBX_result|odbx_result()]]

@@ Line 6: / Line 6: @@
       odbx_result_t* '''result''' )
-= Description: =
+= Description =
-Deletes all resources allocated by [[OpenDBX_result|odbx_result()]]. You must not free() "result" by yourself because this will create memory leaks and you have to call odbx_result_free() even if the statement returned now rows. This is indicated by a return value of "2" for not SELECT-like queries.
+'''odbx_result_free()''' releases all resources allocated by [[OpenDBX_result|odbx_result()]] or by the native database library which are attached to '''result'''. It also frees the memory the first parameter is pointing to. Trying to free() '''result''' manually will create memory leaks because it contains more dynamically allocated structures and also the result set allocated by the native database library. '''odbx_result_free()''' must be called even if the statement was not a SELECT-like statement which returned now rows.
-= Parameters: =
+'''result''' must be a result set object created by [[OpenDBX_result|odbx_result()]] which is returned via its second parameter. After feeding it to '''odbx_result_free()''' it becomes invalid and must not be feed to it again. Otherwise a "double free" will occur and the application will be terminated.
-* result: Object created by [[OpenDBX_result|odbx_result()]]
+= Return values =
-= Return values: =
+This function doesn't return any values.
-* None
+= Errors =
-= Errors: =
+'''odbx_result_free()''' tries its best to cleanup the allocated structure and doesn't generate an error.
-* None
+= See also =
-= See also: =
+[[OpenDBX_result|odbx_result()]]
 ----
 Back to [[OpenDBX API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
-  void odbx_result_free(
+ '''#include <odbx.h>'''
       odbx_result_t* result )
 = Description: =

@@ Line 19: / Line 19: @@
 * None
 ----
 Back to [[OpenDBX API|Overview]]

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

← Older revision	Revision as of 15:17, 17 May 2007
(No difference)