Difference between revisions of "OpenDBX/C API/odbx get option"
From Linuxnetworks
(→Errors:) |
(→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 to | + | * value: Pointer to a integer variable where the option result should be stored |
| + | |||
| + | |||
| + | {| class="wikitable" style="border: 1px solid #000000" | ||
| + | |- | ||
| + | ! Option !! Description !! Value | ||
| + | |- | ||
| + | | ODBX_OPT_API_VERSION || Api version of the backend || integer | ||
| + | |- | ||
| + | | ODBX_OPT_THREAD_SAFE || Thread safe backend || boolean | ||
| + | |- | ||
| + | | ODBX_OPT_TLS || Encryption (SSL/TLS) support || boolean | ||
| + | |- | ||
| + | | ODBX_OPT_MULTI_STATEMENTS || Multiple statments per query || boolean | ||
| + | |- | ||
| + | | ODBX_OPT_PAGED_RESULTS || Transfer of multiple rows at once || boolean | ||
| + | |- | ||
| + | | ODBX_OPT_COMPRESS || Support of compressed || boolean | ||
| + | |} | ||
= Return values: = | = Return values: = | ||
Revision as of 20:51, 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 listed below
- value: Pointer to a integer variable where the option result should be stored
| Option | Description | Value |
|---|---|---|
| ODBX_OPT_API_VERSION | Api version of the backend | integer |
| ODBX_OPT_THREAD_SAFE | Thread safe backend | boolean |
| ODBX_OPT_TLS | Encryption (SSL/TLS) support | boolean |
| ODBX_OPT_MULTI_STATEMENTS | Multiple statments per query | boolean |
| ODBX_OPT_PAGED_RESULTS | Transfer of multiple rows at once | boolean |
| ODBX_OPT_COMPRESS | Support of compressed | boolean |
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
