NAME

addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr, mvaddnwstr, mvwaddwstr, mvwaddnwstr − Add a string of wchar_t characters to a curses window and advance cursor

LIBRARY

The curses library (libcurses.so, libcurses.a)

SYNOPSIS

#include <curses.h>

int addwstr( wchar_t ∗wstr );

int addnwstr(
        wchar_t ∗wstr,
        int n);

int waddwstr(
        WINDOW ∗win,
        wchar_t ∗wstr );

int waddnwstr(
        WINDOW ∗win,
        wchar_t ∗wstr,
        int n );

int mvaddwstr(
        int y,
        int x,
        wchar_t ∗wstr );

int mvaddnwstr(
        int y,
        int x,
        wchar_t ∗wstr,
        int n );

int mvwaddwstr(
        WINDOW ∗win,
        int y,
        int x,
        wchar_t ∗wstr );

int mvwaddnwstr(
        WINDOW ∗win,
        int y,
        int x,
        wchar_t ∗wstr,
        int n );

PARAMETERS

wstrSpecifies the wide-character string to be added to the window. 

winSpecifies a curses window. If not specified, the window is the default window stdscr. 

y, xSpecifies the line (y) and column (x) coordinates of the target position on the window.  If coordinates are not specified, the target position is the current position of the logical cursor. 

nSpecifies the maximum number of wide characters to be added from the string. 

DESCRIPTION

The addwstr routine writes all the characters of the null-terminated wchar_t character string wstr on the default window at the current (y, x) coordinates. 

The addnwstr routine writes at most n characters of the null-terminated wchar_t character string wstr on the default window at the current (y, x) coordinates. 

The waddwstr routine writes all the characters of the null terminated wchar_t character string wstr on the specified window at the current (y, x) coordinates. 

The waddnwstr routine writes at most n characters of the null terminated wchar_t character string wstr on the specified window at the current (y, x) coordinates. 

The mvaddwstr routine writes all the characters of the null terminated wchar_t character string wstr on the default window at the specified (y, x) coordinates. 

The mvaddnwstr routine writes at most n characters of the null terminated wchar_t character string wstr on the default window at the specified (y, x) coordinates. 

The mvwaddwstr routine writes all the characters of the null terminated wchar_t character string wstr on the specified window at the specified (y, x) coordinates. 

The mvwaddnwstr routine writes at most n characters of the null terminated wchar_t character string wstr on the specified window at the specified (y, x) coordinates. 

The following information applies to all the routines:

       •ERR is returned if writing the string causes illegal scrolling. 

In this case, the routine writes as much as possible of the string on the window. 

       •The routines are functionally equivalent to calling addwch or waddwch once for each wchar_t character in the string. 

The addwstr, addnwstr, waddwstr, mvaddwstr, mvaddnwstr, mvwaddwstr and mvwaddnwstr routines are macros. 

RETURN VALUES

The addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr, mvaddnwstr, mvwaddwstr, and mvwaddnwstr routines return OK on success and ERR on error. 

RELATED INFORMATION

Functions: addwch(3), addwchstr(3), curses(3), curses_intro(3), inswstr(3).