brlapi_write man page on YellowDog

Man page or keyword search:  
man Server   18644 pages
apropos Keyword Search (all sections)
Output format
YellowDog logo
[printable version]

Writing on the braille display(3)   BrlAPI   Writing on the braille display(3)

NAME
       Writing on the braille display - Write text to the braille display.

   Data Structures
       struct brlapi_writeStruct

   Defines
       #define BRLAPI_WRITESTRUCT_INITIALIZER	{ -1, 0, 0, NULL, NULL, NULL,
	   -1, NULL };

   Functions
       int brlapi_writeText (int cursor, const char *str)
       int brlapi_writeDots (const unsigned char *dots)
       int brlapi_write (const brlapi_writeStruct *s)

Detailed Description
       Once brlapi_getTty() was called, the application can call
       brlapi_writeText() 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.

	   Dots are coded as described in ISO/TR 11548-1: dot 1 is set iff bit
	   0 is set, dot 2 is set iff bit 1 is set, ... dot i+1 is set iff bit
	   i is set. This also corresponds to the low-order byte of the coding
	   of unicode's braille row U+2800.

Define Documentation
   #define BRLAPI_WRITESTRUCT_INITIALIZER   { -1, 0, 0, NULL, NULL, NULL, -1,
       NULL };
       Allows to initialize a structure of type brlapi_writeStruct * with
       default values: displayNumber = -1; (unspecified) regionBegin =
       regionEnd = 0; (update the whole display) text = attrAnd = attrOr =
       NULL; (no text, no attribute) cursor = -1; (don't touch cursor)

Function Documentation
   int brlapi_write (const brlapi_writeStruct * s)
       Update a specific region of the braille display and apply and/or masks

       Parameters:
	   s gives information necesarry for the update

       Returns:
	   0 on success, -1 on error.

   int brlapi_writeDots (const unsigned 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.

   int brlapi_writeText (int 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. The current LC_CTYPE locale is considered, unless it is left
       as default 'C', in which case the charset is assumed to be 8bits, and
       the same as the server's.

       Parameters:
	   cursor gives the cursor position; if equal to 0, no cursor is shown
	   at all; if cursor==-1, the cursor is left where it is
	   str points to the string to be displayed.

       Returns:
	   0 on success, -1 on error.

Version 1.0			  26 Dec 2005Writing on the braille display(3)
[top]

List of man pages available for YellowDog

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net