Difference between revisions of "OpenDBX/C API/odbx query"
From Linuxnetworks
(header) |
(→Return values:) |
||
| Line 20: | Line 20: | ||
* length: Length of the query string without the terminating \0 character | * length: Length of the query string without the terminating \0 character | ||
| − | = Return values | + | = Return values = |
| − | + | '''odbx_get_option()''' 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: = | ||
Revision as of 22:26, 9 March 2007
#include <odbx.h>
int odbx_query(
odbx_t* handle,
const char* query,
unsigned long length )
Description:
Sends a query string to the database server which must be terminated by a \0 character. Some backends support multiple statements per query, which can be tested by calling odbx_get_option().
After invoking odbx_query(), the results sent back by the server are available via the odbx_result() function.
Parameters:
- handle: Connection object created by odbx_init()
- query: String terminated by \0 consisting of one or more statements
- length: Length of the query string without the terminating \0 character
Return values
odbx_get_option() 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 odbx_error() and odbx_error_type() to get further details.
Errors:
- -ODBX_ERR_BACKEND: Any error returned by the backend
- -ODBX_ERR_PARAM: "handle" or query string are NULL or the structure is invalid
- -ODBX_ERR_NOMEM: Allocating new memory failed
See also:
Back to Overview
