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

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
(see also)
(header)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
  int odbx_query(
+
'''#include <odbx.h>'''
     odbx_t* handle,
+
     const char* query,
+
  int '''odbx_query'''(
     unsigned long length )
+
     odbx_t* '''handle''',
 +
     const char* '''query''',
 +
     unsigned long '''length''' )
  
 
= Description: =
 
= Description: =

Revision as of 00:10, 15 February 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_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

See also:



Back to Overview