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

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
(Errors:)
(Description:)
Line 8: Line 8:
 
= Description: =
 
= Description: =
  
Sends a query statement to the database server. Some backends support multiple statement queries, which can be tested by calling [[OpenDBX_get_option|odbx_get_option()]]. The query string must be terminated by a \0 character.
+
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 [[OpenDBX_get_option|odbx_get_option()]].
 +
 
 +
After invoking odbx_query(), the results sent back by the server are available via the [[OpenDBX_result|odbx_result()]] function.
  
 
= Parameters: =
 
= Parameters: =

Revision as of 18:02, 5 June 2006


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_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