iOS Manual Pages

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

curs_addwstr(3X)                                              curs_addwstr(3X)



NAME
       addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr, mvaddnwstr,
       mvwaddwstr, mvwaddnwstr - add a string of wide characters to a curses
       window and advance cursor

SYNOPSIS
       #include <curses.h>

       int addwstr(const wchar_t *wstr);
       int addnwstr(const wchar_t *wstr, int n);
       int waddwstr(WINDOW *win, const wchar_t *wstr);
       int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);
       int mvaddwstr(int y, int x, const wchar_t *wstr);
       int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);
       int mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr);
       int mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);

DESCRIPTION
       These  routines  write  the characters of the (null-terminated) wchar_t
       character string wstr on the given window.  It is similar to construct-ing constructing
       ing a cchar_t for each wchar_t in the string, then calling wadd_wch for
       the resulting cchar_t.

       The mv routines perform cursor movement once, before writing any  char-acters. characters.
       acters.  Thereafter, the cursor is advanced as a side-effect of writing
       to the window.

       The four routines with n as the last argument write at most  n  wchar_t
       characters.   If  n  is -1, then the entire string will be added, up to
       the maximum number of characters that will fit on the line, or until  a
       terminating null is reached.

RETURN VALUES
       All routines return the integer ERR upon failure and OK on success.

NOTES
       Note that all of these routines except waddnwstr may be macros.

PORTABILITY
       All  these entry points are described in the XSI Curses standard, Issue
       4.

SEE ALSO
       Functions: curses(3X), curs_add_wch(3X)



                                                              curs_addwstr(3X)