brlapi_handles(3) [centos man page]

BrlAPI handles(3)						      BrlAPI							 BrlAPI handles(3)

NAME

       BrlAPI handles -

   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.

Version 1.0							  Mon Apr 1 2013						 BrlAPI handles(3)

Getting Terminal information(3) 				      BrlAPI					   Getting Terminal information(3)

NAME

       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_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  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_tsize)
   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_tsize)
       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 ''.

       Parameters:
	   buffer is the buffer given 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 to small (same as snprintf()).

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

Version 1.0							  Fri Jun 7 2013				   Getting Terminal information(3)