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

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
(Parameters:)
(Parameters:)
Line 12: Line 12:
  
 
* handle: Connection object created by odbx_init()
 
* handle: Connection object created by odbx_init()
* cap: Capability defined in odbx.h
+
* cap: Capability sets listed below
 
+
** ODBX_CAP_BASIC: Core set implemented by all backends
Available capabilities are:
+
 
+
* ODBX_CAP_BASIC: Core set implemented by all backends
+
  
 
= Return values: =
 
= Return values: =

Revision as of 12:44, 5 June 2006


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.

Parameters:

  • handle: Connection object created by odbx_init()
  • cap: Capability sets listed below
    • ODBX_CAP_BASIC: Core set implemented by all backends

Return values:

  • One if capability is supported
  • Zero if capability is not supported
  • Less than zero if an error occured

Errors:

  • -ODBX_ERR_PARAM: Parameter is NULL



Back to Overview