1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>BrlAPI: Getting Terminal information</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Getting Terminal information</h1>
<p>How to get information about the connected Terminal.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__info.html#gaf08ce7e19b97f1d954cd9e6f96e4b742">BRLAPI_MAXNAMELENGTH</a> 31</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__info.html#ga2dcd2285e75571a861c1f9c27a44bd0f">brlapi_getDriverName</a> (char *buffer, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__info.html#ga17eaf29ddaa9c6d33a20402cb5b8eea8">brlapi__getDriverName</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, char *buffer, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__info.html#ga3df1f8106020b1fa4a4b34380abeb191">brlapi_getDisplaySize</a> (unsigned int *x, unsigned int *y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__info.html#ga912f0dd0c626ae01a02d1511c65c8625">brlapi__getDisplaySize</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, unsigned int *x, unsigned int *y)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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.</p>
<p>One should also check for display size, so as to adjust further displaying on it. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gaf08ce7e19b97f1d954cd9e6f96e4b742"></a><!-- doxytag: member="brlapi.h::BRLAPI_MAXNAMELENGTH" ref="gaf08ce7e19b97f1d954cd9e6f96e4b742" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_MAXNAMELENGTH 31</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum name length for names embeded in BrlAPI packets, not counting any termination \0 character </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga912f0dd0c626ae01a02d1511c65c8625"></a><!-- doxytag: member="brlapi.h::brlapi__getDisplaySize" ref="ga912f0dd0c626ae01a02d1511c65c8625" args="(brlapi_handle_t *handle, unsigned int *x, unsigned int *y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__getDisplaySize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga17eaf29ddaa9c6d33a20402cb5b8eea8"></a><!-- doxytag: member="brlapi.h::brlapi__getDriverName" ref="ga17eaf29ddaa9c6d33a20402cb5b8eea8" args="(brlapi_handle_t *handle, char *buffer, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__getDriverName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga3df1f8106020b1fa4a4b34380abeb191"></a><!-- doxytag: member="brlapi.h::brlapi_getDisplaySize" ref="ga3df1f8106020b1fa4a4b34380abeb191" args="(unsigned int *x, unsigned int *y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_getDisplaySize </td>
<td>(</td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the size of the braille display </p>
</div>
</div>
<a class="anchor" id="ga2dcd2285e75571a861c1f9c27a44bd0f"></a><!-- doxytag: member="brlapi.h::brlapi_getDriverName" ref="ga2dcd2285e75571a861c1f9c27a44bd0f" args="(char *buffer, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_getDriverName </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the complete name of the driver used by <em>brltty</em> </p>
<p>This function fills its argument with the whole name of the braille terminal if available, terminated with a '\0'.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>is the buffer given by the application; </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>is the maximum size for the name buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>-1 on error, or a positive value giving the size of the needed buffer, if the supplied one is to small (same as snprintf()). </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 May 2010 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
