---
name: "brlapi_handles"
section: "3"
platform: "linux"
package: "libbrlapi-dev"
version: "6.7-3.1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/brlapi_handles"
---

# brlapi\_handles(3)

BrlAPI handles

## NAME

brlapi\_handles - BrlAPI handles

## SYNOPSIS

### Typedefs

typedef struct **brlapi\_handle\_t** **brlapi\_handle\_t**\

### Functions

size\_t **BRLAPI\_STDCALL** **brlapi\_getHandleSize** (void)\

## Detailed Description

Each function provided by BrlAPI comes in two versions.

- 1\.

  A version whose name is prefixed by brlapi\_ for clients opening only one simultaneous connection with BrlAPI (most frequen case)

- 2\.

  A version whose name is prefixed by brlapi\_\_ for use by clients wishing to open more than one connection to BrlAPI.

A function called brlapi\_\_foo is used in exactly the same way as its brlapi\_foo counterpart, except that it takes an additional argument (the first one), which is a handle letting the client refer to a given connection in a similar manner to what file descriptors do.

In case you want to check that your code is not erroneously using brlapi\_foo functions, define BRLAPI\_NO\_SINGLE\_SESSION before including \<**brlapi.h**\>: that will disable the declaration of all single session functions.

## Typedef Documentation

### typedef struct brlapi\_handle\_t brlapi\_handle\_t

Type for BrlAPI hanles

## Function Documentation

### size\_t BRLAPI\_STDCALL brlapi\_getHandleSize (void)

Returns the size of an object of type brlapi\_handle\_t in bytes

## Author

Generated automatically by Doxygen for BrlAPI from the source code.