Getting Terminal informatioLibrary Functions MaGetting Terminal information(3)



NAME
       Getting Terminal information - How to get information about the
       connected Terminal.  More...

   Functions
       int brlapi_getDriverId (unsigned char *id, size_t n)
       int brlapi_getDriverName (unsigned char *name, size_t n)
       int brlapi_getDisplaySize (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.

FUNCTION DOCUMENTATION
   int brlapi_getDisplaySize (unsigned int * x, unsigned int * y)
       return the size of the braille display

   int brlapi_getDriverId (unsigned char * id, size_t n)
       Identify the driver used by brltty

       This function will fill its argument with the brltty 2-chars code of
       the driver currently in use, to which it adds a '\0'.

       Parameters:

       id     is the buffer given by the application

       n      is the maximum size of the id buffer

       Returns:
           -1 on error, or a positive value giving the size of the needed
           buffer, if the supplied one is to small (same as snprintf)

   int brlapi_getDriverName (unsigned char * name, size_t n)
       return the complete name of the driver used by brltty

       This function fills its argument with the whole name of the braille
       terminal if available, terminated with a '\0'.

       Parameters:

       name   is the buffer given by the application

       n      is the maximum size for the name buffer

       Returns:
           -1 on error, or aApositive value giving the size of the needed
           buffer, if th supplied one is to small (same as snprintf)



BrlAPI                            13 Jul 2004  Getting Terminal information(3)
