- in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wch-
- str, mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an
- array of complex characters and renditions from a curses
- window
+
+ in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr,
+ mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an array of complex
+ characters and renditions from a curses window
-
#include<curses.h>intin_wchstr(cchar_t*wchstr);
@@ -67,54 +64,56 @@
intmvwin_wchnstr(WINDOW*win,inty,intx,cchar_t*wchstr, int n);
-
-
DESCRIPTION
- These functions return an array of complex characters in
- wchstr, starting at the current cursor position in the
- named window. Attributes (rendition) are stored with the
- characters.
+
+ These functions return an array of complex characters in wchstr, start-
+ ing at the current cursor position in the named window. Attributes
+ (rendition) are stored with the characters.
- The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchn-
- str fill the array with at most ncchar_t elements.
+ The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the
+ array with at most ncchar_t elements.
-
Note that all routines except win_wchnstr may be macros.
- Reading a line that overflows the array pointed to by wch-
- str with in_wchstr, mvin_wchstr, mvwin_wchstr or win_wch-
- str causes undefined results. Therefore, the use of
- in_wchnstr, mvin_wchnstr, mvwin_wchnstr, or win_wchnstr is
- recommended.
+ Reading a line that overflows the array pointed to by wchstr with
+ in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined re-
+ sults. Therefore, the use of in_wchnstr, mvin_wchnstr, mvwin_wchnstr,
+ or win_wchnstr is recommended.
-
-
RETURN VALUES
- Upon successful completion, these functions return OK.
- Otherwise, they return ERR.
+
+ Upon successful completion, these functions return OK. Otherwise, they
+ return ERR.
+ Functions with a "mv" prefix first perform a cursor movement using
+ wmove, and return an error if the position is outside the window, or if
+ the window pointer is null.
-
-
PORTABILITY
- The XSI Curses defines no error conditions. This imple-
- mentation checks for null pointers, returning ERR in that
- case.
+