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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BrlAPI: Parameter management</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">BrlAPI<span id="projectnumber"> 0.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search',false);
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Parameter management</div></div>
</div><!--header-->
<div class="contents">
<p>How to manage BrlAPI parameters.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae0a7a21efa88464aa595815bd6b94adc" id="r_gae0a7a21efa88464aa595815bd6b94adc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae0a7a21efa88464aa595815bd6b94adc">BRLAPI_PARAMF_LOCAL</a>   0X00</td></tr>
<tr class="separator:gae0a7a21efa88464aa595815bd6b94adc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc52007f6c60508b58b89e34dd553dd4" id="r_gafc52007f6c60508b58b89e34dd553dd4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafc52007f6c60508b58b89e34dd553dd4">BRLAPI_PARAMF_GLOBAL</a>   0X01</td></tr>
<tr class="separator:gafc52007f6c60508b58b89e34dd553dd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ea393f92f9153d26d121ae368678c77" id="r_ga0ea393f92f9153d26d121ae368678c77"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0ea393f92f9153d26d121ae368678c77">BRLAPI_PARAMF_SELF</a>   0X02</td></tr>
<tr class="separator:ga0ea393f92f9153d26d121ae368678c77"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga5d275bb36c808b5442593929eb1dbb2d" id="r_ga5d275bb36c808b5442593929eb1dbb2d"><td class="memItemLeft" align="right" valign="top">typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td></tr>
<tr class="separator:ga5d275bb36c808b5442593929eb1dbb2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae386e27adddd3bcf5fdf378d70fe03ee" id="r_gae386e27adddd3bcf5fdf378d70fe03ee"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae386e27adddd3bcf5fdf378d70fe03ee">brlapi_paramCallback_t</a>) (<a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, void *priv, const void *data, size_t len)</td></tr>
<tr class="separator:gae386e27adddd3bcf5fdf378d70fe03ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga330857965e9bfb0916a8a455189c3314" id="r_ga330857965e9bfb0916a8a455189c3314"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a></td></tr>
<tr class="separator:ga330857965e9bfb0916a8a455189c3314"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga98d54aab015cf203e3ab07f870106d71" id="r_ga98d54aab015cf203e3ab07f870106d71"><td class="memItemLeft" align="right" valign="top">ssize_t <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga98d54aab015cf203e3ab07f870106d71">brlapi_getParameter</a> (<a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, void *data, size_t len)</td></tr>
<tr class="separator:ga98d54aab015cf203e3ab07f870106d71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf990688f172e126f78911d5ec139cd85" id="r_gaf990688f172e126f78911d5ec139cd85"><td class="memItemLeft" align="right" valign="top">ssize_t <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf990688f172e126f78911d5ec139cd85">brlapi__getParameter</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, void *data, size_t len)</td></tr>
<tr class="separator:gaf990688f172e126f78911d5ec139cd85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4717956164c391ae2718356f69aacb2a" id="r_ga4717956164c391ae2718356f69aacb2a"><td class="memItemLeft" align="right" valign="top">void *<a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4717956164c391ae2718356f69aacb2a">brlapi_getParameterAlloc</a> (<a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, size_t *len)</td></tr>
<tr class="separator:ga4717956164c391ae2718356f69aacb2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacb275fdd30cdc5ffa40ed672d0813ec0" id="r_gacb275fdd30cdc5ffa40ed672d0813ec0"><td class="memItemLeft" align="right" valign="top">void *<a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacb275fdd30cdc5ffa40ed672d0813ec0">brlapi__getParameterAlloc</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, size_t *len)</td></tr>
<tr class="separator:gacb275fdd30cdc5ffa40ed672d0813ec0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c60626783bca2db8be2f13577bc7a74" id="r_ga4c60626783bca2db8be2f13577bc7a74"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4c60626783bca2db8be2f13577bc7a74">brlapi_setParameter</a> (<a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, const void *data, size_t len)</td></tr>
<tr class="separator:ga4c60626783bca2db8be2f13577bc7a74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac34f241ffc47ae352f0a969c52e79314" id="r_gac34f241ffc47ae352f0a969c52e79314"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac34f241ffc47ae352f0a969c52e79314">brlapi__setParameter</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, const void *data, size_t len)</td></tr>
<tr class="separator:gac34f241ffc47ae352f0a969c52e79314"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35baff069a8f443d9f0e403a2a1ec298" id="r_ga35baff069a8f443d9f0e403a2a1ec298"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga35baff069a8f443d9f0e403a2a1ec298">brlapi_watchParameter</a> (<a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, <a class="el" href="#gae386e27adddd3bcf5fdf378d70fe03ee">brlapi_paramCallback_t</a> func, void *priv, void *data, size_t len)</td></tr>
<tr class="separator:ga35baff069a8f443d9f0e403a2a1ec298"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac3e47d0a19e924493511e4542d3aa15" id="r_gaac3e47d0a19e924493511e4542d3aa15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaac3e47d0a19e924493511e4542d3aa15">brlapi__watchParameter</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, <a class="el" href="#gae386e27adddd3bcf5fdf378d70fe03ee">brlapi_paramCallback_t</a> func, void *priv, void *data, size_t len)</td></tr>
<tr class="separator:gaac3e47d0a19e924493511e4542d3aa15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gada9130bcae1b3e0f7dd52e3155270a16" id="r_gada9130bcae1b3e0f7dd52e3155270a16"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gada9130bcae1b3e0f7dd52e3155270a16">brlapi_unwatchParameter</a> (<a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a> descriptor)</td></tr>
<tr class="separator:gada9130bcae1b3e0f7dd52e3155270a16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf73d5405114a93cde7b401d46fac7085" id="r_gaf73d5405114a93cde7b401d46fac7085"><td class="memItemLeft" align="right" valign="top">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf73d5405114a93cde7b401d46fac7085">brlapi__unwatchParameter</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a> descriptor)</td></tr>
<tr class="separator:gaf73d5405114a93cde7b401d46fac7085"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga782298bde7cda8e91bd54e9537e2c6eb" id="r_ga782298bde7cda8e91bd54e9537e2c6eb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> { <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba056a621b557527bb19533b547aec076c">BRLAPI_PARAM_SERVER_VERSION</a> = 0
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba74630ebe9bc45915d3f33e330962a706">BRLAPI_PARAM_CLIENT_PRIORITY</a> = 1
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba1e9e4a177bd74d1fb263fda2f9127440">BRLAPI_PARAM_DRIVER_NAME</a> = 2
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebafab1bcd37e240dc1e97938528fccb7a6">BRLAPI_PARAM_DRIVER_CODE</a> = 3
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba6b3c8d708ac3cf5211f477bcf5f96ead">BRLAPI_PARAM_DRIVER_VERSION</a> = 4
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebae8fa964e21edc5d231be7e1a709d6e57">BRLAPI_PARAM_DEVICE_MODEL</a> = 5
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba4ac44d2c38c1b1707965f4948823e6b9">BRLAPI_PARAM_DEVICE_CELL_SIZE</a> = 31
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba0bfc553e62e53187dd0563f2b6d31d46">BRLAPI_PARAM_DISPLAY_SIZE</a> = 6
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba58bf13fb22ef0bdc0e6f992a83855315">BRLAPI_PARAM_DEVICE_IDENTIFIER</a> = 7
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebadb56099a0d5ae37b17be5dbaff6f1e19">BRLAPI_PARAM_DEVICE_SPEED</a> = 8
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba8051cb5cb068a823d9941a000e99ab94">BRLAPI_PARAM_DEVICE_ONLINE</a> = 9
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebacdf1e6fef2e5a0355476079d6a269c59">BRLAPI_PARAM_RETAIN_DOTS</a> = 10
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebaf42e57e573f36b56c42bb0462f14858f">BRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE</a> = 11
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba2415f973bdca1909e805b89477ddb9d4">BRLAPI_PARAM_LITERARY_BRAILLE</a> = 12
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebaf2de26d35413561709db613eb0b900fb">BRLAPI_PARAM_CURSOR_DOTS</a> = 13
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebac4d456b137ef32d279f1c733b5c88678">BRLAPI_PARAM_CURSOR_BLINK_PERIOD</a> = 14
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebab3fba156f05230ab95a1b9cd543dc1ce">BRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE</a> = 15
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebac2a1f31466a19157db93943633ce762e">BRLAPI_PARAM_RENDERED_CELLS</a> = 16
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba0075aa5952774b864c33cc36802ae7ac">BRLAPI_PARAM_SKIP_IDENTICAL_LINES</a> = 17
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba6e48f8efab337f11505af38bd4968fe3">BRLAPI_PARAM_AUDIBLE_ALERTS</a> = 18
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba87df8e95938f1d2916e15bce13aa51dd">BRLAPI_PARAM_CLIPBOARD_CONTENT</a> = 19
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba17d55fbf9ddbd99d6304e62e1f87367c">BRLAPI_PARAM_BOUND_COMMAND_KEYCODES</a> = 20
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba31ee6d41ca7cb5dffcbfffa73c517a56">BRLAPI_PARAM_COMMAND_KEYCODE_NAME</a> = 21
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba5279bdfe6c0c764eb228a09767ece0a8">BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY</a> = 22
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebafdbc7395cd1c72ef18367e0bb33991f2">BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES</a> = 23
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba6f71ae20656b7a289bd8e726095d5583">BRLAPI_PARAM_DRIVER_KEYCODE_NAME</a> = 24
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba36d3475597c3c79317ece68fc255a703">BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY</a> = 25
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba7b0dbcf585d4cd651a16a3ee2337c905">BRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK</a> = 26
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba7b66a8deeb3f0082d3b92a8979c1d3bd">BRLAPI_PARAM_COMPUTER_BRAILLE_ROW_CELLS</a> = 27
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebadefd346f4e4ccd89a5f4bdf15a1fb992">BRLAPI_PARAM_COMPUTER_BRAILLE_TABLE</a> = 28
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebabfe68442f91e34a94c6184fd411e020b">BRLAPI_PARAM_LITERARY_BRAILLE_TABLE</a> = 29
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6ebaebc3ee0baf70a01a7305a4e441c6bd7d">BRLAPI_PARAM_MESSAGE_LOCALE</a> = 30
, <br />
  <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba84971f522d32c0607f5737297b28b81c">BRLAPI_PARAM_DRIVER_PROPERTY_VALUE</a> = 32
, <a class="el" href="#gga782298bde7cda8e91bd54e9537e2c6eba39d3a631facb14fd66546cb8a13071dc">BRLAPI_PARAM_COUNT</a> = 33
<br />
}</td></tr>
<tr class="separator:ga782298bde7cda8e91bd54e9537e2c6eb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>There are several kinds of parameters:</p><ul>
<li>states associated with the braille device itself, such as its size or parameters of the device port</li>
<li>states of the BrlAPI connection itself, such as the displaying level or key passing preferences.</li>
<li>general states such as the cut buffer,</li>
<li>braille parameters: braille table, contraction, cursor shape, etc,</li>
<li>browse parameters: line skip, beep, etc.</li>
</ul>
<p>Some of them are subdivided in subparameters. Others have only subparameter 0.</p>
<p>Some of them are read-only, others are read/write.</p>
<p>A client can either request the immediate content of a parameter by using <a class="el" href="#ga98d54aab015cf203e3ab07f870106d71">brlapi_getParameter()</a>; set the content of a parameter by using <a class="el" href="#ga4c60626783bca2db8be2f13577bc7a74">brlapi_setParameter()</a>; or register a callback that may be called immediately and on each change of a given parameter, by using <a class="el" href="#ga35baff069a8f443d9f0e403a2a1ec298">brlapi_watchParameter()</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gafc52007f6c60508b58b89e34dd553dd4" name="gafc52007f6c60508b58b89e34dd553dd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc52007f6c60508b58b89e34dd553dd4">◆ </a></span>BRLAPI_PARAMF_GLOBAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_PARAMF_GLOBAL   0X01</td>
</tr>
</table>
</div><div class="memdoc">
<p>Refer to the global value instead of the value local to the connection </p>
</div>
</div>
<a id="gae0a7a21efa88464aa595815bd6b94adc" name="gae0a7a21efa88464aa595815bd6b94adc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae0a7a21efa88464aa595815bd6b94adc">◆ </a></span>BRLAPI_PARAMF_LOCAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_PARAMF_LOCAL   0X00</td>
</tr>
</table>
</div><div class="memdoc">
<p>Refer to the value local to the connection instead of the global value </p>
</div>
</div>
<a id="ga0ea393f92f9153d26d121ae368678c77" name="ga0ea393f92f9153d26d121ae368678c77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ea393f92f9153d26d121ae368678c77">◆ </a></span>BRLAPI_PARAMF_SELF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_PARAMF_SELF   0X02</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify whether to receive notifications of value self-changes </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga5d275bb36c808b5442593929eb1dbb2d" name="ga5d275bb36c808b5442593929eb1dbb2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d275bb36c808b5442593929eb1dbb2d">◆ </a></span>brlapi_param_flags_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags for parameter requests </p>
</div>
</div>
<a id="gae386e27adddd3bcf5fdf378d70fe03ee" name="gae386e27adddd3bcf5fdf378d70fe03ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae386e27adddd3bcf5fdf378d70fe03ee">◆ </a></span>brlapi_paramCallback_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* brlapi_paramCallback_t) (<a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a> parameter, <a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a> subparam, <a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a> flags, void *priv, const void *data, size_t len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback for parameter changes</p>
<p>When a parameter gets changed, application-defined callbacks set by the <a class="el" href="#ga35baff069a8f443d9f0e403a2a1ec298">brlapi_watchParameter()</a> function are called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>is the parameter that changed; </td></tr>
<tr><td class="paramname">subparam</td><td>is a specific instance of the parameter; </td></tr>
<tr><td class="paramname">flags</td><td>specify which value and how it was changed; </td></tr>
<tr><td class="paramname">priv</td><td>is the void pointer that was passed to the brlapi_watchParameter call which registered the callback; </td></tr>
<tr><td class="paramname">data</td><td>is a buffer containing the new value of the parameter; </td></tr>
<tr><td class="paramname">len</td><td>is the size of the data.</td></tr>
</table>
</dd>
</dl>
<p>This callback only gets called when the application calls some brlapi_ function (i.e. BrlAPI gets direct control of the execution), BrlAPI itself does not start a separate thread or such.</p>
<p>If an application wants to see such event trigger a callback getting called e.g. in another thread, it can use <a class="el" href="group__brlapi__misc.html#ga5c930dbe3d4a3708266629f7639eb72b">brlapi_pause()</a> to give BrlAPI an opportunity to receive messages and call the callbacks. </p>
</div>
</div>
<a id="ga330857965e9bfb0916a8a455189c3314" name="ga330857965e9bfb0916a8a455189c3314"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga330857965e9bfb0916a8a455189c3314">◆ </a></span>brlapi_paramCallbackDescriptor_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for callback descriptors This is returned by brlapi_watchParameter, to be passed to brlapi_unwatchParameter. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga782298bde7cda8e91bd54e9537e2c6eb" name="ga782298bde7cda8e91bd54e9537e2c6eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga782298bde7cda8e91bd54e9537e2c6eb">◆ </a></span>brlapi_param_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba056a621b557527bb19533b547aec076c" name="gga782298bde7cda8e91bd54e9537e2c6eba056a621b557527bb19533b547aec076c"></a>BRLAPI_PARAM_SERVER_VERSION </td><td class="fielddoc"><p>Version of the server: uint32_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba74630ebe9bc45915d3f33e330962a706" name="gga782298bde7cda8e91bd54e9537e2c6eba74630ebe9bc45915d3f33e330962a706"></a>BRLAPI_PARAM_CLIENT_PRIORITY </td><td class="fielddoc"><p>Priority of the client: uint32_t (from 0 through 100, default is 50) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba1e9e4a177bd74d1fb263fda2f9127440" name="gga782298bde7cda8e91bd54e9537e2c6eba1e9e4a177bd74d1fb263fda2f9127440"></a>BRLAPI_PARAM_DRIVER_NAME </td><td class="fielddoc"><p>Full name of the driver: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebafab1bcd37e240dc1e97938528fccb7a6" name="gga782298bde7cda8e91bd54e9537e2c6ebafab1bcd37e240dc1e97938528fccb7a6"></a>BRLAPI_PARAM_DRIVER_CODE </td><td class="fielddoc"><p>Code (short name) of the driver: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba6b3c8d708ac3cf5211f477bcf5f96ead" name="gga782298bde7cda8e91bd54e9537e2c6eba6b3c8d708ac3cf5211f477bcf5f96ead"></a>BRLAPI_PARAM_DRIVER_VERSION </td><td class="fielddoc"><p>Version of the driver: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebae8fa964e21edc5d231be7e1a709d6e57" name="gga782298bde7cda8e91bd54e9537e2c6ebae8fa964e21edc5d231be7e1a709d6e57"></a>BRLAPI_PARAM_DEVICE_MODEL </td><td class="fielddoc"><p>Model of the device: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba4ac44d2c38c1b1707965f4948823e6b9" name="gga782298bde7cda8e91bd54e9537e2c6eba4ac44d2c38c1b1707965f4948823e6b9"></a>BRLAPI_PARAM_DEVICE_CELL_SIZE </td><td class="fielddoc"><p>Number of dots in a cell: uint8_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba0bfc553e62e53187dd0563f2b6d31d46" name="gga782298bde7cda8e91bd54e9537e2c6eba0bfc553e62e53187dd0563f2b6d31d46"></a>BRLAPI_PARAM_DISPLAY_SIZE </td><td class="fielddoc"><p>Dimensions of the braille display: { uint32_t columns; uint32_t rows; } </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba58bf13fb22ef0bdc0e6f992a83855315" name="gga782298bde7cda8e91bd54e9537e2c6eba58bf13fb22ef0bdc0e6f992a83855315"></a>BRLAPI_PARAM_DEVICE_IDENTIFIER </td><td class="fielddoc"><p>Identifier of the device: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebadb56099a0d5ae37b17be5dbaff6f1e19" name="gga782298bde7cda8e91bd54e9537e2c6ebadb56099a0d5ae37b17be5dbaff6f1e19"></a>BRLAPI_PARAM_DEVICE_SPEED </td><td class="fielddoc"><p>Speed of the device: uint32_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba8051cb5cb068a823d9941a000e99ab94" name="gga782298bde7cda8e91bd54e9537e2c6eba8051cb5cb068a823d9941a000e99ab94"></a>BRLAPI_PARAM_DEVICE_ONLINE </td><td class="fielddoc"><p>Device is online: boolean </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebacdf1e6fef2e5a0355476079d6a269c59" name="gga782298bde7cda8e91bd54e9537e2c6ebacdf1e6fef2e5a0355476079d6a269c59"></a>BRLAPI_PARAM_RETAIN_DOTS </td><td class="fielddoc"><p>Pass dot combinations (rather than characters): boolean </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebaf42e57e573f36b56c42bb0462f14858f" name="gga782298bde7cda8e91bd54e9537e2c6ebaf42e57e573f36b56c42bb0462f14858f"></a>BRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE </td><td class="fielddoc"><p>Number of dots used to render a computer braille character: uint8_t (8 or 6) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba2415f973bdca1909e805b89477ddb9d4" name="gga782298bde7cda8e91bd54e9537e2c6eba2415f973bdca1909e805b89477ddb9d4"></a>BRLAPI_PARAM_LITERARY_BRAILLE </td><td class="fielddoc"><p>Whether braille is literary (rather than computer): boolean </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebaf2de26d35413561709db613eb0b900fb" name="gga782298bde7cda8e91bd54e9537e2c6ebaf2de26d35413561709db613eb0b900fb"></a>BRLAPI_PARAM_CURSOR_DOTS </td><td class="fielddoc"><p>Representation of the cursor: uint8_t (ISO 11548-1) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebac4d456b137ef32d279f1c733b5c88678" name="gga782298bde7cda8e91bd54e9537e2c6ebac4d456b137ef32d279f1c733b5c88678"></a>BRLAPI_PARAM_CURSOR_BLINK_PERIOD </td><td class="fielddoc"><p>Blinking period of the cursor: uint32_t (milliseconds) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebab3fba156f05230ab95a1b9cd543dc1ce" name="gga782298bde7cda8e91bd54e9537e2c6ebab3fba156f05230ab95a1b9cd543dc1ce"></a>BRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE </td><td class="fielddoc"><p>Portion of the blinking period that the cursor is visible: uint8_t (from 0 through 100) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebac2a1f31466a19157db93943633ce762e" name="gga782298bde7cda8e91bd54e9537e2c6ebac2a1f31466a19157db93943633ce762e"></a>BRLAPI_PARAM_RENDERED_CELLS </td><td class="fielddoc"><p>Cells rendered by the client: uint8_t[] (ISO 11548-1), one cell per element </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba0075aa5952774b864c33cc36802ae7ac" name="gga782298bde7cda8e91bd54e9537e2c6eba0075aa5952774b864c33cc36802ae7ac"></a>BRLAPI_PARAM_SKIP_IDENTICAL_LINES </td><td class="fielddoc"><p>Whether to skip identical screen lines: boolean </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba6e48f8efab337f11505af38bd4968fe3" name="gga782298bde7cda8e91bd54e9537e2c6eba6e48f8efab337f11505af38bd4968fe3"></a>BRLAPI_PARAM_AUDIBLE_ALERTS </td><td class="fielddoc"><p>Whether to use audible alerts: boolean </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba87df8e95938f1d2916e15bce13aa51dd" name="gga782298bde7cda8e91bd54e9537e2c6eba87df8e95938f1d2916e15bce13aa51dd"></a>BRLAPI_PARAM_CLIPBOARD_CONTENT </td><td class="fielddoc"><p>Content of the clipboard: UTF-8 string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba17d55fbf9ddbd99d6304e62e1f87367c" name="gga782298bde7cda8e91bd54e9537e2c6eba17d55fbf9ddbd99d6304e62e1f87367c"></a>BRLAPI_PARAM_BOUND_COMMAND_KEYCODES </td><td class="fielddoc"><p>Commands bound by the driver: uint64_t[], one command keycode per element </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba31ee6d41ca7cb5dffcbfffa73c517a56" name="gga782298bde7cda8e91bd54e9537e2c6eba31ee6d41ca7cb5dffcbfffa73c517a56"></a>BRLAPI_PARAM_COMMAND_KEYCODE_NAME </td><td class="fielddoc"><p>Name for a command keycode (specified via the subparam argument): string (usually a few characters) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba5279bdfe6c0c764eb228a09767ece0a8" name="gga782298bde7cda8e91bd54e9537e2c6eba5279bdfe6c0c764eb228a09767ece0a8"></a>BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY </td><td class="fielddoc"><p>Description for a command keycode (specified via the subparam argument): string (usually a few words) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebafdbc7395cd1c72ef18367e0bb33991f2" name="gga782298bde7cda8e91bd54e9537e2c6ebafdbc7395cd1c72ef18367e0bb33991f2"></a>BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES </td><td class="fielddoc"><p>Keycodes defined by the driver: uint64_t[], one keycode per element </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba6f71ae20656b7a289bd8e726095d5583" name="gga782298bde7cda8e91bd54e9537e2c6eba6f71ae20656b7a289bd8e726095d5583"></a>BRLAPI_PARAM_DRIVER_KEYCODE_NAME </td><td class="fielddoc"><p>Name for a driver keycode (specified via the subparam argument): string (usually a few characters) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba36d3475597c3c79317ece68fc255a703" name="gga782298bde7cda8e91bd54e9537e2c6eba36d3475597c3c79317ece68fc255a703"></a>BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY </td><td class="fielddoc"><p>Description for a driver keycode (specified via the subparam argument): string (usually a few words) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba7b0dbcf585d4cd651a16a3ee2337c905" name="gga782298bde7cda8e91bd54e9537e2c6eba7b0dbcf585d4cd651a16a3ee2337c905"></a>BRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK </td><td class="fielddoc"><p>Set of Unicode rows that are defined for computer braille (from U+0000 through U+10FFFF): uint8_t[544], one bit per row, eight rows per element </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba7b66a8deeb3f0082d3b92a8979c1d3bd" name="gga782298bde7cda8e91bd54e9537e2c6eba7b66a8deeb3f0082d3b92a8979c1d3bd"></a>BRLAPI_PARAM_COMPUTER_BRAILLE_ROW_CELLS </td><td class="fielddoc"><p>Computer braille cells for a Unicode row (specified via the subparam argument): uint8_t[256] (ISO 11548-1), one cell per element </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebadefd346f4e4ccd89a5f4bdf15a1fb992" name="gga782298bde7cda8e91bd54e9537e2c6ebadefd346f4e4ccd89a5f4bdf15a1fb992"></a>BRLAPI_PARAM_COMPUTER_BRAILLE_TABLE </td><td class="fielddoc"><p>Name of the computer braille table: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebabfe68442f91e34a94c6184fd411e020b" name="gga782298bde7cda8e91bd54e9537e2c6ebabfe68442f91e34a94c6184fd411e020b"></a>BRLAPI_PARAM_LITERARY_BRAILLE_TABLE </td><td class="fielddoc"><p>Name of the literary braille table: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6ebaebc3ee0baf70a01a7305a4e441c6bd7d" name="gga782298bde7cda8e91bd54e9537e2c6ebaebc3ee0baf70a01a7305a4e441c6bd7d"></a>BRLAPI_PARAM_MESSAGE_LOCALE </td><td class="fielddoc"><p>Locale to use for messages: string </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba84971f522d32c0607f5737297b28b81c" name="gga782298bde7cda8e91bd54e9537e2c6eba84971f522d32c0607f5737297b28b81c"></a>BRLAPI_PARAM_DRIVER_PROPERTY_VALUE </td><td class="fielddoc"><p>Value of a driver-specific property: uint32_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga782298bde7cda8e91bd54e9537e2c6eba39d3a631facb14fd66546cb8a13071dc" name="gga782298bde7cda8e91bd54e9537e2c6eba39d3a631facb14fd66546cb8a13071dc"></a>BRLAPI_PARAM_COUNT </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf990688f172e126f78911d5ec139cd85" name="gaf990688f172e126f78911d5ec139cd85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf990688f172e126f78911d5ec139cd85">◆ </a></span>brlapi__getParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__getParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gacb275fdd30cdc5ffa40ed672d0813ec0" name="gacb275fdd30cdc5ffa40ed672d0813ec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacb275fdd30cdc5ffa40ed672d0813ec0">◆ </a></span>brlapi__getParameterAlloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void *<a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__getParameterAlloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gac34f241ffc47ae352f0a969c52e79314" name="gac34f241ffc47ae352f0a969c52e79314"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac34f241ffc47ae352f0a969c52e79314">◆ </a></span>brlapi__setParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__setParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaf73d5405114a93cde7b401d46fac7085" name="gaf73d5405114a93cde7b401d46fac7085"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf73d5405114a93cde7b401d46fac7085">◆ </a></span>brlapi__unwatchParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__unwatchParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a></td> <td class="paramname"><span class="paramname"><em>descriptor</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaac3e47d0a19e924493511e4542d3aa15" name="gaac3e47d0a19e924493511e4542d3aa15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac3e47d0a19e924493511e4542d3aa15">◆ </a></span>brlapi__watchParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__watchParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#gae386e27adddd3bcf5fdf378d70fe03ee">brlapi_paramCallback_t</a></td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>priv</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga98d54aab015cf203e3ab07f870106d71" name="ga98d54aab015cf203e3ab07f870106d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga98d54aab015cf203e3ab07f870106d71">◆ </a></span>brlapi_getParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_getParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the content of a parameter</p>
<p>brlapi_getParameter gets the current content of a parameter</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>is the parameter whose content shall be gotten; </td></tr>
<tr><td class="paramname">subparam</td><td>is a specific instance of the parameter; </td></tr>
<tr><td class="paramname">flags</td><td>specify which value and how it should be returned; </td></tr>
<tr><td class="paramname">data</td><td>is a buffer where content of the parameter shall be stored; </td></tr>
<tr><td class="paramname">len</td><td>is the size of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the real size of the parameter's content. If the parameter does not fit in the provided buffer, it is truncated to len bytes (but the real size of the parameter is still returned). In that case, the client must call brlapi_getParameter again with a big enough buffer. </dd></dl>
</div>
</div>
<a id="ga4717956164c391ae2718356f69aacb2a" name="ga4717956164c391ae2718356f69aacb2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4717956164c391ae2718356f69aacb2a">◆ </a></span>brlapi_getParameterAlloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void *<a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_getParameterAlloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the content of a parameter</p>
<p>brlapi_getParameterAlloc gets the current content of a parameter, by returning it as a newly-allocated buffer. The buffer is allocated to one byte more than the parameter value. This byte is set to zero. This allows, for string parameters, to be able to immediately use it as a C string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>is the parameter whose content shall be gotten; </td></tr>
<tr><td class="paramname">subparam</td><td>is a specific instance of the parameter; </td></tr>
<tr><td class="paramname">flags</td><td>specify which value and how it should be returned; </td></tr>
<tr><td class="paramname">len</td><td>is the address where to store the size of the parameter value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a newly-allocated buffer that contains the value of the parameter. The caller must call free() on it after use. NULL is returned on errors </dd></dl>
</div>
</div>
<a id="ga4c60626783bca2db8be2f13577bc7a74" name="ga4c60626783bca2db8be2f13577bc7a74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c60626783bca2db8be2f13577bc7a74">◆ </a></span>brlapi_setParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_setParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the content of a parameter</p>
<p>brlapi_setParameter sets the content of a parameter</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>is the parameter to set; </td></tr>
<tr><td class="paramname">subparam</td><td>is a specific instance of the parameter; </td></tr>
<tr><td class="paramname">flags</td><td>specify which value and how it should be set; </td></tr>
<tr><td class="paramname">data</td><td>is a buffer containing the data to store in the parameter; </td></tr>
<tr><td class="paramname">len</td><td>is the size of the data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error (read-only parameter for instance). </dd></dl>
</div>
</div>
<a id="gada9130bcae1b3e0f7dd52e3155270a16" name="gada9130bcae1b3e0f7dd52e3155270a16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gada9130bcae1b3e0f7dd52e3155270a16">◆ </a></span>brlapi_unwatchParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_unwatchParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a></td> <td class="paramname"><span class="paramname"><em>descriptor</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear a parameter change callback</p>
<p>brlapi_unwatchParameter unregisters a parameter change callback: the callback function previously registered with brlapi_watchParameter will not be called any longer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">descriptor</td><td>refers to the callback to be removed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
</div>
</div>
<a id="ga35baff069a8f443d9f0e403a2a1ec298" name="ga35baff069a8f443d9f0e403a2a1ec298"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga35baff069a8f443d9f0e403a2a1ec298">◆ </a></span>brlapi_watchParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ga330857965e9bfb0916a8a455189c3314">brlapi_paramCallbackDescriptor_t</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_watchParameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ga782298bde7cda8e91bd54e9537e2c6eb">brlapi_param_t</a></td> <td class="paramname"><span class="paramname"><em>parameter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="brlapi__param_8h.html#ab84a200f74588b3486e19ee4122b6a48">brlapi_param_subparam_t</a></td> <td class="paramname"><span class="paramname"><em>subparam</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ga5d275bb36c808b5442593929eb1dbb2d">brlapi_param_flags_t</a></td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#gae386e27adddd3bcf5fdf378d70fe03ee">brlapi_paramCallback_t</a></td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>priv</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a parameter change callback</p>
<p>brlapi_watchParameter registers a parameter change callback: whenever the given parameter changes, the given function is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>is the parameter to watch; </td></tr>
<tr><td class="paramname">subparam</td><td>is a specific instance of the parameter; </td></tr>
<tr><td class="paramname">flags</td><td>specify which value and how it should be monitored; </td></tr>
<tr><td class="paramname">func</td><td>is the function to call on parameter change; </td></tr>
<tr><td class="paramname">priv</td><td>is a void pointer which will be passed as such to the function; </td></tr>
<tr><td class="paramname">data</td><td>is a buffer where the current content of the parameter shall be stored; </td></tr>
<tr><td class="paramname">len</td><td>is the size of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the callback descriptor (to be passed to brlapi_unwatchParameter to unregister the callback), or NULL on error.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Default parameter callbacks don't do anything, except the ones for display size which just raise SIGWINCH. </dd>
<dd>
If data is NULL, the callback will be called immediately by brlapi_watchParameter, for providing the initial value </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
|
