in_wchstr3
Get a curses complex character string from a window
Part of curs_in_wchstr(3).
Usage
#include <curses.h>
int in_wchstr(cchar_t * wchstr); int win_wchstr(WINDOW * win, cchar_t * wchstr); int mvin_wchstr(int y, int x, cchar_t * wchstr); int mvwin_wchstr(WINDOW * win, int y, int x, cchar_t * wchstr);
int in_wchnstr(cchar_t * wchstr, int n); int win_wchnstr(WINDOW * win, cchar_t * wchstr, int n); int mvin_wchnstr(int y, int x, cchar_t * wchstr, int n); int mvwin_wchnstr(WINDOW * win, int y, int x, cchar_t * wchstr, int n)
Overview
win_wchstr extracts a curses complex character string from a curses window win, starting at the cursor and stopping at the end of the line, and stores it in wchstr, terminating it with a wide null curses character. win_wchnstr does the same, but copies at most n curses complex characters from win. A negative n implies no limit; win_wchnstr then works like win_wchstr. ncurses(3X) describes the variants of these functions.
Return value
These functions return OK on success and ERR on failure.
In ncurses, these functions fail if
•
|
|
|---|---|
•
|
(for functions taking a WINDOW pointer argument) win is a null pointer, |
•
|
wchstr is a null pointer. |
Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.
Notes
All of these functions except win_wchnstr may be implemented as macros.
Reading a line that overflows the array pointed to by wchstr and its variants causes undefined results. Instead, use the n-infixed functions with a positive n argument no larger than the size of the buffer backing wchstr.
Portability
X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.
Releases
46 releases since FreeBSD 6.3-RELEASE; the text changed 7 times.