brlapi_info(3)                      BrlAPI                      brlapi_info(3)



NAME
       brlapi_info - 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 driver names embedded 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, 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.

   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, 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.

Author
       Generated automatically by Doxygen for BrlAPI from the source code.



Version 0.8                     Tue Feb 17 2026                 brlapi_info(3)
