Difference between revisions of "OpenDBX/C API/odbx set option"
From Linuxnetworks
(→Parameters:) |
(→Description:) |
||
| Line 8: | Line 8: | ||
= Description: = | = Description: = | ||
| − | Sets the specified options in the backend. | + | Sets the specified options in the backend. You should test the option with [[OpenDBX_set_option|odbx_set_option()]] before trying to set it to a new value. Otherwise you might get an error if the option is not supported by the backend. |
= Parameters: = | = Parameters: = | ||
Revision as of 21:10, 5 June 2006
int odbx_set_option(
odbx_t* handle,
unsigned int option,
void* value )
Description:
Sets the specified options in the backend. You should test the option with odbx_set_option() before trying to set it to a new value. Otherwise you might get an error if the option is not supported by the backend.
Parameters:
- handle: Connection object created by odbx_init()
- option: Options listed below
- value: Pointer of the variable where the option value (most of the time zero or one) is stored
| Option | Description | Values |
|---|---|---|
| ODBX_OPT_MULTI_STATEMENTS | Multiple statements per query | boolean |
| ODBX_OPT_PAGED_RESULTS | Transfer of multiple rows at once | boolean |
| ODBX_OPT_COMPRESS | Support of compressed | boolean |
| ODBX_OPT_TLS | Encryption (SSL/TLS) support | ODBX_TLS_NEVER ODBX_TLS_TRY ODBX_TLS_ALWAYS |
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
