curs_inwchstr(S)

curs_inwchstr: inwchstr, inwchnstr, winwchstr, winwchnstr, mvinwchstr, mvinwchnstr, mvwinwchstr, mvwinwchnstr -- get a string of wchar_t characters (and attributes) from a curses window

Syntax

cc ... -lcurses

#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);

Description

These routines return a string of type chtype, holding wchar_t characters, starting at the current cursor position in the specified window and ending at the right margin of the window. The four functions with n as the last argument, return the string at most n wchar_t characters long. Constants defined in curses.h can be used with the & (logical AND) operator to extract the wchar_t character or the attribute alone from any position in the chstr (see curs_inwch(S)).

Return values

All routines return the integer ERR on failure and an integer value other than ERR on successful completion.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

All routines except winwchnstr(S) can be macros.

Files

/usr/lib/libcurses.a: the library

Standards conformance

inwchstr(S), inwchnstr(S), winwchstr(S), winwchnstr(S), mvinwchstr(S), mvinwchnstr(S), mvwinwchstr(S), and mvwinwchnstr(S) are not part of any currently supported standard; they are extensions of AT&T System V developed by The Santa Cruz Operation, Inc. and maintained by The SCO Group.