---
name: "odbx_capabilities"
section: "3"
platform: "linux"
package: "opendbx"
version: "1.4.6-13"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/odbx_capabilities"
---

# odbx\_capabilities(3)

Query implemented capabilities

## NAME

odbx\_capabilities - Query implemented capabilities

## SYNOPSIS

```
FC#include <opendbx/api.h>F[0]
```

FCint **odbx\_capabilities**F\[0\]  FC(odbx\_t\* *handle*, unsigned int *cap*);F\[0\]

## DESCRIPTION

FC**odbx\_capabilities**F\[0\]() ask the backend associated to the connection object returned by FC**odbx\_init**F\[0\]() if a certain capability set is implemented by this backend. All backends have to implement the basic capability set and may implement further predefined functional sets if they are supported by the native database client library. This function can be called at any stage after FC**odbx\_init**F\[0\]() returned successfully.

The first parameter FChandleF\[0\] has to be the connection object created and returned by FC**odbx\_init**F\[0\](). It becomes invalid as soon as it was supplied to FC**odbx\_finish**F\[0\]() and FC**odbx\_capabilities**F\[0\]() will return an error in this case.

FCcapF\[0\] is the number of the capability set as defined by macro constants in odbx.h. Valid constant names which can be supplied as second parameter to FC**odbx\_capabilities**F\[0\]() are listed below:

- \-FCODBX\_CAP\_BASICF\[0\]

  The core function set which have to be implemented by all backends. It consists of all functions necessary to connect to, send textual queries to and process simple results returned from the database server as well as error handling functions.

## RETURN VALUE

FC**odbx\_capabilities**F\[0\]() returns FCODBX\_ENABLEF\[0\] if the requested capability is supported, FCODBX\_DISABLEF\[0\] if the capability is not supported or an error code whose value is less than zero if one of the supplied parameters is invalid. Possible error codes are listed in the error section and they can be feed to FC**odbx\_error**F\[0\]() and FC**odbx\_error\_type**F\[0\]() to get further details.

## ERRORS

- \-FCODBX\_ERR\_PARAMF\[0\]

  FChandleF\[0\] is NULL or the supplied connection object is invalid

## SEE ALSO

FC**odbx\_error**F\[0\](), FC**odbx\_error\_type**F\[0\](), FC**odbx\_init**F\[0\]()