OpenDBX/C API/odbx set option

From Linuxnetworks
< OpenDBX‎ | C API
Revision as of 18:16, 5 June 2006 by Nose (Talk | contribs)

Jump to: navigation, search


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

Description:

Sets the specified options in the backend. Look in odbx.h for available options.

Parameters:

  • handle: Connection object created by odbx_init()
  • option: Options defined in odbx.h
  • value: Pointer of the variable where the option value (most of the time zero or one) is stored

Return values:

  • ODBX_ERR_SUCCESS 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
  • -ODBX_ERR_OPTRO: Option is read-only
  • -ODBX_ERR_OPTWR: Setting option failed



Back to Overview