brlapi_info - Getting Terminal information
Contents
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.
Function Documentation
intBRLAPI_STDCALLbrlapi__getDisplaySize(brlapi_handle_t*handle,unsignedint*x,unsignedint*y)intBRLAPI_STDCALLbrlapi__getDriverName(brlapi_handle_t*handle,char*buffer,size_tsize)intBRLAPI_STDCALLbrlapi__getModelIdentifier(brlapi_handle_t*handle,char*buffer,size_tsize)intBRLAPI_STDCALLbrlapi_getDisplaySize(unsignedint*x,unsignedint*y)
Return the size of the braille display
intBRLAPI_STDCALLbrlapi_getDriverName(char*buffer,size_tsize)
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'.
Parametersbuffer is the buffer provided by the application;
size is the maximum size for the name buffer.
Returns
-1 on error, otherwise a positive value giving the size of the needed buffer (including '\0'). If
that value is bigger than size, the value was truncated and the caller should retry with a bigger
buffer accordingly.
intBRLAPI_STDCALLbrlapi_getModelIdentifier(char*buffer,size_tsize)
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'.
Parametersbuffer is the buffer given by the application;
size is the maximum size for the identifier buffer.
Returns
-1 on error, otherwise a positive value giving the size of the needed buffer (including '\0'). If
that value is bigger than size, the value was truncated and the caller should retry with a bigger
buffer accordingly.
Macro Definition Documentation
#defineBRLAPI_MAXNAMELENGTH31
Maximum name length for driver names embeded in BrlAPI packets, not counting any termination \0 character
Name
brlapi_info - Getting Terminal information
- How to get information about the connected Terminal.
Synopsis
Macros
#define BRLAPI_MAXNAMELENGTH 31
Functions
int BRLAPI_STDCALLbrlapi_getDriverName (char *buffer, size_t size)
int BRLAPI_STDCALLbrlapi__getDriverName (brlapi_handle_t *handle, char *buffer, size_t size)
int BRLAPI_STDCALLbrlapi_getModelIdentifier (char *buffer, size_t size)
int BRLAPI_STDCALLbrlapi__getModelIdentifier (brlapi_handle_t *handle, char *buffer, size_t size)
int BRLAPI_STDCALLbrlapi_getDisplaySize (unsigned int *x, unsigned int *y)
int BRLAPI_STDCALLbrlapi__getDisplaySize (brlapi_handle_t *handle, unsigned int *x, unsigned int *y)
