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

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
 
Line 11: Line 11:
 
= Parameters: =
 
= Parameters: =
  
handle: Connection object created by odbx_init()
+
* handle: Connection object created by odbx_init()
cap: Capability defined in odbx.h
+
* cap: Capability defined in odbx.h
  
 
= Return values: =
 
= Return values: =
  
One if capability is supported
+
* One if capability is supported
Zero if capability is not supported
+
* Zero if capability is not supported
Less than zero if an error occured
+
* Less than zero if an error occured
  
 
= Errors: =
 
= Errors: =
  
-ODBX_ERR_PARAM: Parameter is NULL
+
* -ODBX_ERR_PARAM: Parameter is NULL
  
  
 
----
 
----
 
Back to [[OpenDBX API|Overview]]
 
Back to [[OpenDBX API|Overview]]

Revision as of 18:35, 1 October 2005


int odbx_capabilities(
    odbx_t* handle,
    unsigned int cap ) 

Description:

Asks the backend if a capability is implemented. Currently only ODBX_CAP_BASIC is defined. This function can be called after odbx_init() returns successfully.

Parameters:

  • handle: Connection object created by odbx_init()
  • cap: Capability defined in odbx.h

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