innwstr(3X) innwstr(3X)
NAME
innwstr, inwstr, mvinnwstr, mvinwstr, mvwinnwstr, mvwinwstr, winnwstr,
winwstr - input a string of wide characters from a window
SYNOPSIS
cc [flag ...] file ... -lcurses [library ...]
#include <curses.h>
int innwstr(wchart *wstr, int n);
int inwstr(wchart *wstr);
int mvinnwstr(int y, int x, wchart *wstr, int n);
int mvinwstr(int y, int x, wchart *wstr);
int mvwinnwstr(WINDOW *win, int y, int x, wchart *wstr, int n);
int mvwinwstr(WINDOW *win, int y, int x, wchart *wstr);
int winnwstr(WINDOW *win, wchart *wstr, int n);
int winwstr(WINDOW *win, wchart *wstr);
DESCRIPTION
These functions place a string of wchart characters from the current
or specified window into the array pointed to by wstr starting at the
current or specified cursor position and ending at the end of the
line.
These functions will only store the entire wide character sequence
associated with a spacing complex character. If the array is large
enough to contain at least one complete spacing complex character, the
array is filled with complete characters. If the array is not large
enough to contain any complete characters this is an error.
The innwstr(), mvinnwstr(), mvwinnwstr() and winnwstr() functions
store at most n characters in the array pointed to by wstr.
RETURN VALUE
Upon successful completion, inwstr(), mvinwstr(), mvwinwstr() and
winwstr() return OK.
Upon successful completion, innwstr(), mvinnwstr(), mvwinnwstr() and
winnwstr() return the number of characters actually read into the
string.
Otherwise, all these functions return ERR.
ERRORS
No errors are defined.
Page 1 Reliant UNIX 5.44 Printed 11/98
innwstr(3X) innwstr(3X)
NOTES
Reading a line that overflows the array pointed to by wstr with
inwstr(), mvinwstr(), mvwinwstr() or winwstr() causes undefined
results. The use of innwstr(), mvinnwstr(), mvwinnwstr() or
winnwstr(), respectively, is recommended.
These functions do not return rendition information.
SEE ALSO
curses(3X), curses(5).
Page 2 Reliant UNIX 5.44 Printed 11/98