Index Click this button to go to the index for this section.


curs_inwstr(3)

NAME

curs_inwstr, inwstr, innwstr, winwstr, winnwstr, mvinwstr, mvinnwstr, mvwinwstr, mvwinnwstr - Get a string of wchar_t characters from a Curses window

LIBRARY

Curses Library (libcurses.a, libcurses.so)

SYNOPSIS

#include <curses.h> int inwstr(wchar_t *str); int innwstr(wchar_t *str, int n); int winwstr(WINDOW *win, wchar_t *str); int winnwstr(WINDOW *win, wchar_t *str, int n); int mvinwstr(int y, int x, wchar_t *str); int mvinnwstr(int y, int x, wchar_t *str, int n); int mvwinwstr(WINDOW *win, int y, int x, wchar_t *str); int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *str, int n);

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows: inwstr, innwstr, winwstr, winnwstr, mvinwstr, mvinnwstr, mvwinwstr, mvwinnwstr: XPG4-UNIX Refer to the standards(5) reference page for more information about industry standards and associated tags.

DESCRIPTION

These routines return a string of wchar_t characters in str, starting at the current or specified cursor position in the current or specified window and ending at the right margin of the window. The functions strip attributes from the characters. The four functions with n as the last argument return a string that is at most n wchar_t characters long.

NOTES

The header file curses.h automatically includes the header file stdio.h. Note that all routines except winnwstr may be macros.

RETURN VALUES

All routines return ERR upon failure. Upon successful completion, the *inwstr routines return OK, and the *innwstr routines return the number of characters read into the string.

RELATED INFORMATION

Functions: curses(3) Others: standards(5)