- These functions copy the (null-terminated) array of complex characters
- wchstr into the window image structure starting at the current cursor
- position.
-
- The four functions with n as the last argument copy at most n elements,
- but no more than will fit on the line. If n=-1 then the whole array is
- copied, to the maximum number of characters that will fit on the line.
+ wadd_wchstr copies the string of complex characters wchstr to the
+ window win. A null complex character terminates the string. If a
+ complex character does completely fit at the end of the line, curses
+ fills the remaining columns with the window background; see bkgrnd(3x).
+ wadd_wchnstr does the same, but copies at most n characters, or as many
+ as possible if n is -1. ncurses(3x) describes the variants of these
+ functions.
- The window cursor is not advanced. These functions are faster than
- waddnstr. On the other hand:
+ Because these functions do not call wadd_wch(3x) internally, they are
+ faster than waddwstr(3x) and waddnwstr(3x). On the other hand, they
- o they do not perform checking (such as for the newline, backspace,
- or carriage return characters),
+ o do not treat the backspace, carriage return, or line feed
+ characters specially;
- o they do not advance the current cursor position,
+ o do not represent unprintable characters with wunctrl(3x);
- o they do not expand other control characters to ^-escapes, and
+ o do not update the cursor position to follow the last character
+ written;
- o they truncate the string if it crosses the right margin, rather
- than wrapping it around to the new line.
-
- These functions end successfully on encountering a null cchar_t, or
- when they have filled the current line. If a complex character cannot
- completely fit at the end of the current line, the remaining columns
- are filled with the background character and rendition.
+ o truncate the string at the window's right margin, rather than
+ wrapping it to the next line and potentially scrolling.
- All functions return the integer ERR upon failure and OK on success.
+ These functions return OK on success and ERR on failure.
- X/Open does not define any error conditions. This implementation
- returns an error
+ X/Open Curses does not specify any error conditions. ncurses returns
+ ERR if
- o if the win parameter is null or
+ owin is NULL or
- o if the wchstr parameter is null.
+ owchstr is NULL.
- 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.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.