Difference between revisions of "OpenDBX/C API/odbx query"

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
(Return values:)
(Errors:)
Line 23: Line 23:
 
= Errors: =
 
= Errors: =
  
* -ODBX_ERR_PARAM: One of the parameters or its content is invalid
+
* -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
 
* -ODBX_ERR_NOMEM: Allocating new memory failed
* -1: Any error retured by the backend
 
  
  
 
----
 
----
 
Back to [[OpenDBX API|Overview]]
 
Back to [[OpenDBX API|Overview]]

Revision as of 16:47, 5 June 2006


int odbx_query(
    odbx_t* handle,
    const char* query,
    unsigned long length )

Description:

Sends a query statement to the database server. Some backends support multiple statement queries, which can be tested by calling odbx_get_option(). The query string must be terminated by a \0 character.

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_ERR_SUCCESS on success
  • Less than zero if an error occured

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



Back to Overview