1Getting Terminal information(3)     BrlAPI     Getting Terminal information(3)
2
3
4

NAME

6       Getting Terminal information - How to get information about the
7       connected Terminal.
8
9
10   Defines
11       #define BRLAPI_MAXNAMELENGTH   31
12
13   Functions
14       int BRLAPI_STDCALL brlapi_getDriverName (char *buffer, size_t size)
15       int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t *handle, char
16           *buffer, size_t size)
17       int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int *x, unsigned int
18           *y)
19       int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t *handle,
20           unsigned int *x, unsigned int *y)
21

Detailed Description

23       Before using Raw mode or key codes, the application should always check
24       the type of the connected terminal, to be sure it is really the one it
25       expects.
26
27       One should also check for display size, so as to adjust further
28       displaying on it.
29

Define Documentation

31   #define BRLAPI_MAXNAMELENGTH   31
32       Maximum name length for names embeded in BrlAPI packets, not counting
33       any termination \0 character
34

Function Documentation

36   int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t * handle,
37       unsigned int * x, unsigned int * y)
38   int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t * handle, char *
39       buffer, size_t size)
40   int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int * x, unsigned int *
41       y)
42       Return the size of the braille display
43
44   int BRLAPI_STDCALL brlapi_getDriverName (char * buffer, size_t size)
45       Return the complete name of the driver used by brltty
46
47       This function fills its argument with the whole name of the braille
48       terminal if available, terminated with a '\0'.
49
50       Parameters:
51           buffer is the buffer given by the application;
52           size is the maximum size for the name buffer.
53
54       Returns:
55           -1 on error, or a positive value giving the size of the needed
56           buffer, if the supplied one is to small (same as snprintf()).
57
58Version 1.0                       4 Jun 2007   Getting Terminal information(3)
Impressum