Main Page   Modules   Data Structures   File List   Data Fields   Globals  

Writing on the braille display

write text to the braille display. More...

Functions

int brlapi_writeBrl (uint32_t cursor, const char *str)
int brlapi_writeBrlDots (const char *dots)

Detailed Description

Once brlapi_getTty() was called, the application can call brlapi_writeBrl() to write things on the braille display.

Note:
Be sure to call brlapi_getTty() before calling brlapi_write*(), or else you'll get an error. This is particularly not always trivial when writing multithreaded applications.

Function Documentation

int brlapi_writeBrl uint32_t    cursor,
const char *    str
 

Write the given \0-terminated string to the braille display

If the string is too long, it is cut. If it's too short, spaces are appended.

Parameters:
cursor  gives the cursor position; if less than or equal to 0 or greater than the display width, no cursor is shown at all;
str  points on the string to be displayed.
Returns:
0 on success, -1 on error.

int brlapi_writeBrlDots const char *    dots
 

Write the given dots array to the display

Parameters:
dots  points on an array of dot information, one per character. Its size must hence be the same as what brlapi_getDisplaySize() returns.
Returns:
0 on success, -1 on error.


Generated on Fri Sep 26 09:33:48 2003 for BrlAPI by doxygen1.2.15