NAME

inwstr, innwstr, winwstr, winnwstr, mvinwstr, mvinnwstr, mvwinwstr, mvwinnwstr − Get a string of wchar_t characters from a curses window

LIBRARY

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

SYNOPSIS

#include <curses.h>

int inwstr( wchar_t ∗wstr );

int innwstr(
        wchar_t ∗wstr,
        int n );

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

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

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

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

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

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

PARAMETERS

wstrSpecifies the buffer for storing the wide-character string 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 for the string. 

DESCRIPTION

The inwstr routine returns a string of wchar_t characters in wstr on the default window at the current coordinates. 

The innwstr routine returns at most n wchar_t characters in the pointer wstr on the default window at the current coordinates. 

The winwstr routine returns a string of wchar_t characters in wstr on window win at the current coordinates. 

The routine winnwstr returns at most n wchar_t characters in the pointer wstr on window win at the current coordinates. 

The routine mvinwstr returns a string of wchar_t characters in wstr on the default window at coordinates (y, x). 

The routine mvinnwstr returns at most n wchar_t characters in the pointer wstr on the default window at coordinates (y, x). 

The routine mvwinwstr returns a string of wchar_t characters in wstr on window win at coordinates (y, x). 

The routine mvwinnwstr returns at most n wchar_t characters in the pointer wstr on window win at the coordinates (y, x). 

The following information applies to all the routines.  For all routines, the returned wchar_t character string 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 wstr. 

The inwstr, innwstr, winwstr, mvinwstr, mvinnwstr, mvwinwstr, and mvwinnwstr routines are macros. 

RETURN VALUES

The inwstr, innwstr, winwstr, winnwstr, mvinwstr, mvinnwstr, mvwinwstr, and mvwinnwstr functions return OK on success and ERR on error. 

RELATED INFORMATION

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