brlapi__getDisplaySize - Getting Terminal information - How to get information about the connected Terminal.
Macros #define BRLAPI_MAXNAMELENGTH 31 Functions int BRLAPI_STDCALL brlapi_getDriverName (char *buffer, size_t size) int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t *handle, char *buffer, size_t size) int BRLAPI_STDCALL brlapi_getModelIdentifier (char *buffer, size_t size) int BRLAPI_STDCALL brlapi__getModelIdentifier (brlapi_handle_t *handle, char *buffer, size_t size) int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int *x, unsigned int *y) int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t *handle, unsigned int *x, unsigned int *y)
brlapi_info(3) BrlAPI brlapi_info(3)
NAME
brlapi_info - Getting Terminal information
- How to get information about the connected Terminal.
SYNOPSIS
Macros
#define BRLAPI_MAXNAMELENGTH 31
Functions
int BRLAPI_STDCALL brlapi_getDriverName (char *buffer, size_t size)
int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t *handle, char
*buffer, size_t size)
int BRLAPI_STDCALL brlapi_getModelIdentifier (char *buffer, size_t
size)
int BRLAPI_STDCALL brlapi__getModelIdentifier (brlapi_handle_t *handle,
char *buffer, size_t size)
int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int *x, unsigned int
*y)
int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t *handle,
unsigned int *x, unsigned int *y)
Detailed Description
Before using Raw mode or key codes, the application should always check
the type of the connected terminal, to be sure it is really the one it
expects.
One should also check for display size, so as to adjust further
displaying on it.
Macro Definition Documentation
#define BRLAPI_MAXNAMELENGTH 31
Maximum name length for names embeded in BrlAPI packets, not counting
any termination \0 character
Function Documentation
int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t * handle,
unsigned int * x, unsigned int * y)
int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t * handle, char *
buffer, size_t size)
int BRLAPI_STDCALL brlapi__getModelIdentifier (brlapi_handle_t * handle,
char * buffer, size_t size)
int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int * x, unsigned int *
y)
Return the size of the braille display
int BRLAPI_STDCALL brlapi_getDriverName (char * buffer, size_t size)
Return the complete name of the driver used by brltty
This function fills its argument with the whole name of the braille
driver if available, terminated with a '\0'.
Parameters
buffer is the buffer provided by the application;
size is the maximum size for the name buffer.
Returns
-1 on error, or a positive value giving the size of the needed
buffer, if the supplied one is too small (same as snprintf()).
int BRLAPI_STDCALL brlapi_getModelIdentifier (char * buffer, size_t size)
Return an identifier for the device model used by brltty
This function fills its argument with the whole identifier of the
braille device model if available, terminated with a '\0'.
Parameters
buffer is the buffer given by the application;
size is the maximum size for the identifier buffer.
Returns
-1 on error, or a positive value giving the size of the needed
buffer, if the supplied one is too small (same as snprintf()).
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_info(3)