NAME

inwchstr, inwchnstr, winwchstr, winwchnstr, mvinwchstr, mvinwchnstr, mvwinwchstr, mvwinwchnstr − Get a string of wchar_t characters (with attributes) from a curses window

LIBRARY

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

SYNOPSIS

#include <curses.h>

int inwchstr( chtype ∗wchstr );

int inwchnstr(
        chtype ∗wchstr,
        int n );

int winwchstr(
        WINDOW ∗win,
        chtype ∗wchstr );

int winwchnstr(
        WINDOW ∗win,
        chtype ∗wchstr,
        int n );

int mvinwchstr(
        int y,
        int x,
        chtype ∗wchstr );

int mvinwchnstr(
        int y,
        int x,
        chtype ∗wchstr,
        int n );

int mvwinwchstr(
        WINDOW ∗win,
        int y,
        int x,
        chtype ∗wchstr );

int mvwinwchnstr(
        WINDOW ∗win,
        int y,
        int x,
        chtype ∗wchstr,
        int n );

PARAMETERS

wchstrSpecifies a pointer to the wide-character string to be returned from 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 returned from the string. 

DESCRIPTION

The inwchstr routine gets a string of type chtype on the default window at the current coordinates. 

The inwchnstr routine gets at most n wchar_t characters in the string of type chtype on the default window at the current coordinates. 

The winwchstr routine gets a string of type chtype on window win at the current coordinates. 

The winwchnstr routine gets at most n wchar_t characters in the string of type chtype on window win at the current coordinates. 

The mvinwchstr routine gets a string of type chtype on the default window at coordinates (y, x). 

The mvinwchnstr routine gets at most n wchar_t characters in the string of type chtype on the default window at coordinates (y, x). 

The mvwinwchstr routine gets a string of type chtype on window win at coordinates (y, x). 

The mvwinwchnstr routine gets at most n wchar_t characters in the string of type chtype on window win at coordinates (y, x). 

For all routines, the returned string of type chtype starts from the appropriate cursor position and ends at the right margin of the line in the window. 

For those four routines with n as the last argument, at most n wchar_t characters are returned in the pointer wchstr.  If n is equal to −1, the whole string is returned.  You can extract the wchar_t character or its attribute by using logical AND with each element in the string. 

The inwchstr, inwchnstr, winwchstr, mvinwchstr, mvinwchnstr, mvwinwchstr, and mvwinwchnstr routines are macros. 

RETURN VALUES

The inwchstr, inwchnstr, winwchstr, winwchnstr, mvinwchstr, mvinwchnstr, mvwinwchstr and mvwinwchnstr functions return OK on success and ERR on error. 

RELATED INFORMATION

Functions: curses(3), curses_intro(3), inwch(3), inwstr(3).