Difference between revisions of "OpenDBX/C API/odbx get option"

From Linuxnetworks
< OpenDBX‎ | C API
Jump to: navigation, search
 
(Description:)
Line 8: Line 8:
 
= Description: =
 
= Description: =
  
Queries the backend for supported options. Look in odbx.h for available options.  
+
Asks the backend for supported options. Look in odbx.h for available options.
  
 
= Parameters: =
 
= Parameters: =

Revision as of 16:29, 5 June 2006


int odbx_get_option(
    odbx_t* handle,
    unsigned int option,
    void* value ) 

Description:

Asks the backend for supported options. Look in odbx.h for available options.

Parameters:

  • handle: Connection object created by odbx_init()
  • option: Options defined in odbx.h
  • value: Pointer to the variable where the option value should be stored

Return values:

  • Zero on success
  • Less than zero if an error occured

Errors:

  • -ODBX_ERR_PARAM: One of the parameters or its content is invalid
  • -ODBX_ERR_OPTION: Unknown option



Back to Overview