curs_addwch(3X)                   SDK R4.11                  curs_addwch(3X)


NAME
       cursaddwch:  addwch, waddwch, mvaddwch, mvwaddwch, echowchar,
       wechowchar - add a wchart character to a curses window

SYNOPSIS
       #include <curses.h>

       int addwch(chtype wch);
       int waddwch(WINDOW *win, chtype wch);
       int mvaddwch(int y, int x, chtype wch);
       int mvwaddwch(WINDOW *win, int y, int x, chtype wch);
       int echowchar(chtype wch);
       int wechowchar(WINDOW *win, chtype wch);

DESCRIPTION
       With the addwch, waddwch, mvaddwch and mvwaddwch routines, the
       character wch which is holding a wchart character is put into the
       window at the current cursor position of the window and the position
       of the window cursor is advanced.  Its function is similar to that of
       putwchar in the C multibyte library.  At the right margin, an
       automatic newline is performed.  At the bottom of the scrolling
       region, if scrollok is enabled, the scrolling region is scrolled up
       one line.

       If wch is a tab, newline, or backspace, the cursor is moved
       appropriately within the window.  A newline also does a clrtoeol
       before moving.  Tabs are considered to be at every eighth column.  If
       wch is another control character, it is drawn in the ^X notation.
       Calling winwch after adding a control character does not return the
       control character, but instead returns the representation of the
       control character.

       The echowchar and wechowchar routines are functionally equivalent to
       a call to addwch followed by a call to refresh, or a call to waddwch
       followed by a call to wrefresh.  The knowledge that only a single
       character is being output is taken into consideration and, for non-
       control characters, a considerable performance gain might be seen by
       using these routines instead of their equivalents.

RETURN VALUE
       All routines return the integer ERR upon failure and an integer value
       other than ERR upon successful completion, unless otherwise noted in
       the preceding routine descriptions.

NOTES
       The header file <curses.h> automatically includes the header files
       <stdio.h> and <unctrl.h>.

       Note that addwch, mvaddwch, mvwaddwch, and echowchar may be macros.

SEE ALSO
       curses(3X), cursattr(3X), cursclear(3X), cursinwch(3X),
       cursoutopts(3X), cursrefresh(3X) putwc(3W).


Licensed material--property of copyright holder(s)