mvin_wchnstr3ncurses

Usage

Overview

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 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(3NCURSES)].

Return value

Upon successful completion, these functions return OK. Otherwise, they return ERR.

ncurses returns ERR

•

if the win parameter is null or

•

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.

Notes

All of these functions except win_wchnstr may be implemented as macros.

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.

Portability

X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.