Difference between revisions of "OpenDBX/C API/odbx set option"
From Linuxnetworks
(→Return values:) |
(→Parameters:) |
||
| Line 13: | Line 13: | ||
* handle: Connection object created by [[OpenDBX_init|odbx_init()]] | * handle: Connection object created by [[OpenDBX_init|odbx_init()]] | ||
| − | * option: Options | + | * option: Options listed below |
* value: Pointer of the variable where the option value (most of the time zero or one) is stored | * value: Pointer of the variable where the option value (most of the time zero or one) is stored | ||
| + | |||
| + | |||
| + | {| class="wikitable" | ||
| + | |- style="background: #F0F0F0" | ||
| + | ! 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<br/> ODBX_TLS_TRY<br/>ODBX_TLS_ALWAYS | ||
| + | |} | ||
= Return values: = | = Return values: = | ||
Revision as of 21:02, 5 June 2006
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 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
