brlapi_getHandleSize - BrlAPI handles
Typedefs typedef struct brlapi_handle_t brlapi_handle_t Functions size_t BRLAPI_STDCALL brlapi_getHandleSize (void)
brlapi_handles(3) BrlAPI brlapi_handles(3)
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.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------------------+
|Availability | library/accessibility/brltty |
+---------------+------------------------------+
|Stability | Pass-through volatile |
+---------------+------------------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
http://mielke.cc/brltty//archive/brltty-6.0.tar.xz.
Further information about this software can be found on the open source
community website at http://mielke.cc/brltty/.
Version 0.7 Mon Jun 27 2022 brlapi_handles(3)