HP-UX Reference (11i v2 04/09) - 3 Library Functions A-M (vol 6)

i
in_wchnstr(3X) in_wchnstr(3X)
(ENHANCED CURSES)
NAME
in_wchnstr, in_wchstr, mvin_wchnstr, mvin_wchstr, mvwin_wchnstr, mvwin_wchstr, win_wchnstr,
win_wchstr — input an array of complex characters and renditions from a window
SYNOPSIS
#include <curses.h>
int in_wchnstr(cchar_t *wchstr, int n);
int in_wchstr(cchar_t *wchstr);
int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
int mvin_wchstr(int y, int x, cchar_t *wchstr);
int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);
int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
int win_wchstr(WINDOW *win, cchar_t *wchstr);
DESCRIPTION
These functions extract characters from the current or specified window, 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
in_wchnstr(), mvin_wchnstr()
, mvwin_wchnstr() and win_wchnstr() fill the array
with at most n cchar_t elements.
RETURN VALUE
Upon successful completion, these functions return OK. Otherwise, they return ERR.
ERRORS
No errors are defined.
APPLICATION USAGE
Reading a line that overflows the array pointed to by wchstr with
in_wchstr(),
mvin_wchstr(),
mvwin_wchstr() or win_wchstr()
causes undefined results. The use of in_wchnstr(),
mvin_wchnstr(), mvwin_wchnstr()
or win_wchnstr(), respectively, is recommended.
SEE ALSO
in_wch(3X), <curses.h>.
CHANGE HISTORY
First released in X/Open Curses, Issue 4.
Section 3534 Hewlett-Packard Company 1 HP-UX 11i Version 2: September 2004