1odbx_capabilities(3)                OpenDBX               odbx_capabilities(3)
2
3
4

NAME

6       odbx_capabilities - Query implemented capabilities
7

SYNOPSIS

9       #include <opendbx/api.h>
10
11
12       int odbx_capabilities (odbx_t* handle, unsigned int cap);
13

DESCRIPTION

15       odbx_capabilities() ask the backend associated to the connection object
16       returned by odbx_init() if a certain capability set is  implemented  by
17       this  backend.  All backends have to implement the basic capability set
18       and may implement further predefined functional sets if they  are  sup‐
19       ported  by  the  native  database  client library. This function can be
20       called at any stage after odbx_init() returned successfully.
21
22       The first parameter handle has to be the connection object created  and
23       returned  by odbx_init(). It becomes invalid as soon as it was supplied
24       to odbx_finish() and odbx_capabilities() will return an error  in  this
25       case.
26
27       cap  is  the number of the capability set as defined by macro constants
28       in odbx.h. Valid constant names which can be supplied as second parame‐
29       ter to odbx_capabilities() are listed below:
30
31       -ODBX_CAP_BASIC
32              The  core function set which have to be implemented by all back‐
33              ends. It consists of all functions necessary to connect to, send
34              textual  queries to and process simple results returned from the
35              database server as well as error handling functions.
36

RETURN VALUE

38       odbx_capabilities() returns ODBX_ENABLE if the requested capability  is
39       supported,  ODBX_DISABLE if the capability is not supported or an error
40       code whose value is less than zero if one of the supplied parameters is
41       invalid.  Possible error codes are listed in the error section and they
42       can be feed to odbx_error() and odbx_error_type() to  get  further  de‐
43       tails.
44

ERRORS

46       -ODBX_ERR_PARAM
47              handle is NULL or the supplied connection object is invalid
48

SEE ALSO

50       odbx_error(), odbx_error_type(), odbx_init()
51
52
53
54                                19 January 2023           odbx_capabilities(3)
Impressum