FreeTDS API: LibTDS API

FreeTDS API

Modules
LibTDS API

Callable functions in `libtds`. More...

Collaboration diagram for LibTDS API:

## Modules
| Authentication
| Functions for handling authentication.
| Configuration
| Handle reading of configuration.
| Conversion
| Conversions between datatypes. Supports, for example, dbconvert().
| Charset conversion
| Convert between different charsets.
| Memory allocation
| Allocate or free resources. Allocation can fail only on out of memory. In such case they return NULL and leave the state as before call. Mainly function names are in the form tds_alloc_XX or tds_free_XXX. tds_alloc_XXX functions allocate structures and return pointer to allocated data while tds_free_XXX take structure pointers and free them. Some functions require additional parameters to initialize structure correctly. The main exception are structures that use reference counting. These structures have tds_alloc_XXX functions but instead of tds_free_XXX use tds_release_XXX.
| Query
| Function to handle query.
| Network functions
| Functions for reading or writing from network.
| Results processing
| Handle tokens in packets. Many PDU (packets data unit) contain tokens. (like result description, rows, data, errors and many other).
| Dynamic string functions
| Handle dynamic string. In this string are always valid (you don't have NULL pointer, only empty strings)

## Detailed Description

Callable functions in `libtds`.

The `libtds` library is for use internal to FreeTDS. It is not intended for use by applications. Although any use is permitted, you're encouraged to use one of the established public APIs instead, because their interfaces are stable and documented by the vendors.