in_wchnstr(3X) in_wchnstr(3X)
NAME
inwchnstr, inwchstr, mvinwchnstr, mvinwchstr, mvwinwchnstr,
mvwinwchstr, winwchnstr, winwchstr - extract an array of complex
characters and renditions from a window
SYNOPSIS
cc [flag ...] file ... -lcurses [library ...]
#include <curses.h>
int inwchnstr(cchart *wchstr, int n);
int inwchstr(cchart *wchstr);
int mvinwchnstr(int y, int x, cchart *wchstr, int n);
int mvinwchstr(int y, int x, cchart *wchstr);
int mvwinwchnstr(WINDOW *win, int y, int x, cchart *wchstr, int n);
int mvwinwchstr(WINDOW *win, int y, int x, cchart *wchstr);
int winwchnstr(WINDOW *win, cchart *wchstr, int n);
int winwchstr(WINDOW *win, cchart *wchstr);
DESCRIPTION
These functions extract characters from the current or specified win-
dow, starting at the current or specified position and ending at the
end of the line, and place them in the array pointed to by wchstr.
The inwchnstr(), mvinwchnstr(), mvwinwchnstr() and winwchnstr()
fill the array with at most n cchart elements.
RETURN VALUE
Upon successful completion, these functions return OK. Otherwise, they
return ERR.
ERRORS
No errors are defined.
NOTES
Reading a line that overflows the array pointed to by wchstr with
inwchstr(), mvinwchstr(), mvwinwchstr() or winwchstr() causes
undefined results. The use of inwchnstr(), mvinwchnstr(),
mvwinwchnstr() or winwchnstr(), respectively, is recommended.
SEE ALSO
curses(3X), inwch(3X), curses(5).
Page 1 Reliant UNIX 5.44 Printed 11/98