OpenDBX/C API/odbx capabilities

From Linuxnetworks
< OpenDBX‎ | C API
Revision as of 21:58, 19 February 2007 by Nose (Talk | contribs)

Jump to: navigation, search


#include <odbx.h>

int odbx_capabilities(
    odbx_t* handle,
    unsigned int cap ) 

Description

Asks the backend if a capability set is implemented. This function can be called at each stage after odbx_init() returns successfully.


  • handle: Connection object created by odbx_init()
  • cap: Capability sets listed below

Valid capability sets are:

  • ODBX_CAP_BASIC: Core set implemented by all backends

Return value

odbx_capabilities() returns one ("1") if the requested capability is supported, zero ("0") if the capability is not supported or an error code whose value is less than zero if one of the supplied parameters is invalid. Possible error codes are listed in the error section and they can be used by odbx_error() and odbx_error_type() to get further details.

Errors

-ODBX_ERR_PARAM 
handle is NULL or the supplied connection object is invalid

See also



Back to Overview