- 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.
+
+ These routines insert a character string (as many characters 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 characters on the line being lost. 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<=0, then the entire string is inserted.
+ Special characters are handled as in addch.
-
-
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.
+
+ All routines that return an integer return ERR upon failure and OK
+ (SVr4 specifies only "an integer value other than ERR") upon successful
+ completion, unless otherwise noted in the preceding routine descrip-
+ tions.
-
-
NOTES
+ X/Open defines no error conditions. In this implementation, if the
+ window parameter is null or the str parameter is null, an error is
+ returned.
+
+ 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.
+
+
+
- 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 functions are described in the XSI Curses standard, Issue 4,
+ which adds const qualifiers to the arguments.
+ The Single Unix Specification, Version 2 states that insnstr and win-
+ snstr perform wrapping. This is probably an error, since it makes this
+ group of functions inconsistent. Also, no implementation of curses
+ documents this inconsistency.
-