1BrlAPI handles(3)                   BrlAPI                   BrlAPI handles(3)
2
3
4

NAME

6       BrlAPI handles -
7
8   Typedefs
9       typedef struct brlapi_handle_t brlapi_handle_t
10
11   Functions
12       size_t BRLAPI_STDCALL brlapi_getHandleSize (void)
13

Detailed Description

15       Each function provided by BrlAPI comes in two versions.
16
17       1. A version whose name is prefixed by brlapi_ for clients opening only
18       one simultaneous connection with BrlAPI (most frequen case)
19
20       2. A version whose name is prefixed by brlapi__ for use by clients
21       wishing to open more than one connection to BrlAPI.
22
23       A function called brlapi__foo is used in exactly the same way as its
24       brlapi_foo counterpart, except that it takes an additional argument
25       (the first one), which is a handle letting the client refer to a given
26       connection in a similar manner to what file descriptors do.
27
28       In case you want to check that your code is not erroneously using
29       brlapi_foo functions, define BRLAPI_NO_SINGLE_SESSION before including
30       <brlapi.h>: that will disable the declaration of all single session
31       functions.
32

Typedef Documentation

34   typedef struct brlapi_handle_t brlapi_handle_t
35       Type for BrlAPI hanles
36

Function Documentation

38   size_t BRLAPI_STDCALL brlapi_getHandleSize (void)
39       Returns the size of an object of type brlapi_handle_t in bytes
40
41
42
43Version 1.0                       7 Oct 2009                 BrlAPI handles(3)