- These routines copy the array of complex characters wchstr
- into the window image structure at and after the current
- cursor position. The four routines 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.
-
- The window cursor is not advanced. These routines work
- faster than waddnstr. On the other hand, they do not per-
- form checking (such as for the newline, backspace, or car-
- riage return characters), they do not advance the current
- cursor position, they do not expand other control charac-
- ters to ^-escapes, and they truncate the string if it
- crosses the right margin, rather then wrapping it around
- to the new line.
-
- These routines 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.
-
-
-
-
NOTES
- All functions except wadd_wchnstr may be macros.
-
-
-
-
RETURN VALUES
- All routines return the integer ERR upon failure and OK on
- success.
-
-
-
-
PORTABILITY
- All these entry points are described in the XSI Curses
- standard, Issue 4.
-
-
-
-
+ These functions copy the (null-terminated) array of com-
+ plex characters wchstr into the window image structure
+ starting at the current cursor position. The four func-
+ tions 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.
+ The window cursor is not advanced. These functions work
+ faster than waddnstr. On the other hand:
+ o they do not perform checking (such as for the newline,
+ backspace, or carriage return characters),
+ o they do not advance the current cursor position,
+ o they do not expand other control characters to ^-es-
+ capes, and
+ o they truncate the string if it crosses the right mar-
+ gin, 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.
+
+ All functions return the integer ERR upon failure and OK
+ on success.
+ X/Open does not define any error conditions. This imple-
+ mentation returns an error if the window pointer is null.
+ 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.
+