- 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
+
+ in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr,
+ mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get a curses complex
+ character string from a window
-
- 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,
+ starting 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 four functions with n as the last argument return a leading
+ substring at most n characters long (exclusive of the trailing zeroed
+ cchar_t. Transfer stops at the end of the current line, or when n
+ characters have been stored at the location referenced by wchstr.
+ Constants defined in <curses.h> can be used with the & (logical AND)
+ operator to extract the character or the attribute alone from any
+ position in the wchstr [see getcchar(3x)].
-
-
NOTES
- 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.
+
+ Upon successful completion, these functions return OK. Otherwise, they
+ return ERR.
+ X/Open Curses defines no error conditions. This implementation returns
+ an error
-
-
RETURN VALUE
- Upon successful completion, these functions return OK.
- Otherwise, they return ERR.
+ o if the win parameter is null or
- Functions with a "mv" prefix first perform a cursor move-
- ment using wmove, and return an error if the position is
- outside the window, or if the window pointer is null.
+ o if the wchstr parameter is null.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.
-
-
PORTABILITY
- The XSI Curses defines no error conditions. This imple-
- mentation checks for null pointers, returning ERR in that
- case.
+
+ All routines except win_wchnstr may be macros.
-
-
SEE ALSO
- Functions: curses(3x), curs_in_wch(3x), curs_instr(3x),
- curs_inwstr(3x)curs_inchstr(3x)
+ Reading a line that overflows the array pointed to by wchstr with
+ in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined
+ results. Therefore, the use of in_wchnstr, mvin_wchnstr,
+ mvwin_wchnstr, or win_wchnstr is recommended.
+
+
+