OpenDBX/C API/odbx query - Revision history

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

2009-04-28T21:13:51Z

moved OpenDBX/API/odbx query to OpenDBX/C API/odbx query

Nose: /* Description */

2008-06-15T16:32:58Z

‎Description

Nose: /* Description */

2008-06-15T16:32:21Z

‎Description

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

2007-05-17T15:16:46Z

OpenDBX query moved to OpenDBX/API/odbx query

@@ Line 19: / Line 19: @@
 The statement stored in the '''''stmt''''' parameter must be a valid statement understood by the receiving database server and it should be terminated by a \0 character. Some backends support multiple statements per query, which can be tested by calling [[OpenDBX/API/odbx_get_option|odbx_get_option]]().
-The '''''length''''' parameter must contain the length of the statement in bytes without the terminating \0 character. If variable sized character sets like UTF-8 are used, the same rule applies. This function doesn't support the wide character type (wchar_t) which uses two or four bytes per character. If you feed 0 (zero) as length parameter to the function, it will calculate the size of the statement on its own.
+The '''''length''''' parameter must contain the length of the statement in bytes without the terminating \0 character. If variable sized character sets like UTF-8 are used, the same rule applies. This function doesn't support the wide character type (wchar_t) which uses two or four bytes per character. If you feed 0 (zero) as '''''length''''' parameter to the function, it will calculate the size of the statement on its own.
 == Return value ==

@@ Line 19: / Line 19: @@
 The statement stored in the '''''stmt''''' parameter must be a valid statement understood by the receiving database server and it should be terminated by a \0 character. Some backends support multiple statements per query, which can be tested by calling [[OpenDBX/API/odbx_get_option|odbx_get_option]]().
-The '''''length''''' parameter must contain the length of the statement in bytes without the terminating \0 character. If variable sized character sets like UTF-8 are used, the same rule applies. This function doesn't support the wide character type (wchar_t) which uses two or four bytes per character.
+The '''''length''''' parameter must contain the length of the statement in bytes without the terminating \0 character. If variable sized character sets like UTF-8 are used, the same rule applies. This function doesn't support the wide character type (wchar_t) which uses two or four bytes per character. If you feed 0 (zero) as length parameter to the function, it will calculate the size of the statement on its own.
 == Return value ==

@@ Line 2: / Line 2: @@
 '''Send a statement to the database server'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_query'''(
       odbx_t* '''''handle''''',
@@ Line 37: / Line 37: @@
 * [[OpenDBX/API/odbx_escape|odbx_escape]]()
 * [[OpenDBX/API/odbx_result|odbx_result]]()

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Send a statement to the database server'''
   int '''odbx_query'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      const char* '''stmt''',
+      const char* '''''stmt''''',
-      unsigned long '''length''' )
+      unsigned long '''''length''''' )
 == Description ==
-Sends the given statement to the database server associated to '''handle''' by [[OpenDBX_init|odbx_init()]] for execution.  The statement might contain non-displayable characters as arguments in conditions but they have to be escaped via [[OpenDBX_escape|odbx_escape()]] before adding them to the statement. Even more, every argument whose source is not controlled by the programmer should be escaped first to avoid SQL injection attacks to avoid serious harm!
+Sends the given statement to the database server associated to '''''handle''''' by [[OpenDBX/API/odbx_init|odbx_init]]() for execution. The statement can contain non-displayable characters as arguments in conditions but they have to be escaped via [[OpenDBX/API/odbx_escape|odbx_escape]]() before adding them to the statement. Even more, every argument whose source is not controlled by the programmer must be escaped first to avoid SQL injection attacks to avoid serious harm!
-After invoking '''odbx_query()''', one or more result sets will be sent back by the server and are available via [[OpenDBX_result|odbx_result()]]. Before these sets aren't processed by calling [[OpenDBX_row_fetch|odbx_row_fetch()]], no other queries can be sent to the database server. Otherwise, '''odbx_query()''' will return a backend error from the native database library.
+After invoking [[OpenDBX/API/odbx_query|odbx_query]](), one or more result sets will be sent back by the server and are available via [[OpenDBX/API/odbx_result|odbx_result]](). Before these sets aren't processed by calling [[OpenDBX/API/odbx_row_fetch|odbx_row_fetch]](), no other queries can be sent to the database server. Otherwise, [[OpenDBX/API/odbx_query|odbx_query]]() will return a backend error from the native database library.
-The first parameter '''handle''' is the connection object created and returned by [[OpenDBX_init|odbx_init()]] which becomes invalid as soon as it was supplied to [[OpenDBX_finish|odbx_finish()]].
+The first parameter '''''handle''''' is the connection object created and returned by [[OpenDBX/API/odbx_init|odbx_init]]() which becomes invalid as soon as it was supplied to [[OpenDBX/API/odbx_finish|odbx_finish]]().
-The statement stored in the '''stmt''' parameter must be a valid statement understood by the receiving database server and it should be terminated by a \0 character. Some backends support multiple statements per query, which can be tested by calling [[OpenDBX_get_option|odbx_get_option()]].
+The statement stored in the '''''stmt''''' parameter must be a valid statement understood by the receiving database server and it should be terminated by a \0 character. Some backends support multiple statements per query, which can be tested by calling [[OpenDBX/API/odbx_get_option|odbx_get_option]]().
-The '''length''' parameter should contain the length of the statement in bytes without the terminating \0 character. If variable sized character sets like UTF-8 are used, the same rule applies. This function doesn't support wide characters which use two or four bytes space per character.
+The '''''length''''' parameter must contain the length of the statement in bytes without the terminating \0 character. If variable sized character sets like UTF-8 are used, the same rule applies. This function doesn't support the wide character type (wchar_t) which uses two or four bytes per character.
-== Return values ==
+== Return value ==
-'''odbx_query()''' 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_query|odbx_query]]() 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 because it wasn't able to handle the statement correctly
-; -ODBX_ERR_PARAM : Either '''handle''' or '''query''' are NULL or '''handle''' is invalid
+; -ODBX_ERR_PARAM : Either '''''handle''''' or '''''stmt''''' are NULL or '''''handle''''' is invalid
 ; -ODBX_ERR_NOMEM : Allocating the required memory for the statement failed
 == See also ==
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
-* [[OpenDBX_result]]
+* [[OpenDBX/API/odbx_escape|odbx_escape]]()
-* [[OpenDBX_row_fetch]]
+* [[OpenDBX/API/odbx_result|odbx_result]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

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