- These routines insert a character string (as many charac-
- ters as will fit on the line) before the character under
- the cursor. All characters to the right of the cursor are
- shifted right, with the possibility of the rightmost char-
- acters on the line being lost. The cursor position does
- not change (after moving to y, x, if specified). The four
- routines with n as the last argument insert a leading sub-
- string of at most n characters. If n<=0, then the entire
- string is inserted.
-
- If a character in str is a tab, newline, carriage return
- or backspace, the cursor is moved appropriately within the
- window. A newline also does a clrtoeol before moving.
- Tabs are considered to be at every eighth column. If a
- character in str is another control character, it is drawn
- in the ^X notation. Calling winch after adding a control
- character (and moving to it, if necessary) does not return
- the control character, but instead returns a character in
- the ^-representation of the control character.
-
-
-
-
RETURN VALUE
- All routines that return an integer return ERR upon fail-
- ure and OK (SVr4 specifies only "an integer value other
- than ERR") upon successful completion, unless otherwise
- noted in the preceding routine descriptions.
-
-
-
-
NOTES
- Note that all but winsnstr may be macros.
-
-
-
-
PORTABILITY
- These functions are described in the XSI Curses standard,
- Issue 4, which adds const qualifiers to the arguments.
- The XSI Curses error conditions EILSEQ and EILOVERFLOW
- associated with extended-level conformance are not yet
- detected (this implementation does not yet support XPG4
- multibyte characters).
-
-
-
+ These routines insert a character string (as many characters as will
+ fit on the line) before the character under the cursor, as if calling
+ winsch(3x). All characters to the right of the cursor are shifted
+ right, with the possibility of the rightmost characters on the line
+ being lost. No wrapping is performed.
+ The cursor position does not change (after moving to y, x, if
+ specified).
+ The functions with n as the last argument insert a leading substring of
+ at most n characters. If n is less than zero, the entire string is
+ inserted (stopping on a NUL character).
+ Special characters are handled as in waddch(3x).
+
+ All functions return the integer ERR upon failure and OK on success.
+ X/Open Curses does not specify any error conditions. This
+ implementation returns an error
+ o if the win parameter is null or
+ o if the str parameter is null or
+ o the winsch(3x) function returns an error.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.
+
+ These functions are described in X/Open Curses, Issue 4, which adds
+ const qualifiers to the arguments.
+ The Single Unix Specification, Version 2 states that insnstr and
+ winsnstr perform wrapping. This is probably an error, since it makes
+ this group of functions inconsistent. Also, no implementation of
+ curses documents this inconsistency.
+ X/Open states that the entire string is inserted if n is less than 1.
+ This is probably an error, because it is inconsistent with other
+ functions, and differs from the SVr4 and X/Open implementations on
+ Solaris.
+