Difference between revisions of "OpenDBX/C API/odbx get option"
From Linuxnetworks
(→Return values:) |
(→Errors:) |
||
| Line 23: | Line 23: | ||
= Errors: = | = Errors: = | ||
| − | * -ODBX_ERR_PARAM: | + | * -ODBX_ERR_PARAM: "handle" is NULL or the structure is invalid |
* -ODBX_ERR_OPTION: Unknown option | * -ODBX_ERR_OPTION: Unknown option | ||
Revision as of 16:31, 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:
- ODBX_ERR_SUCCESS on success
- Less than zero if an error occured
Errors:
- -ODBX_ERR_PARAM: "handle" is NULL or the structure is invalid
- -ODBX_ERR_OPTION: Unknown option
Back to Overview
