- 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
- 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.
+
+ 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.
- X/Open defines no error conditions. In this implementa-
- tion, if the window parameter is null or the str parameter
- is null, an error is returned.
+ 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 move-
- ment using wmove, and return an error if the position is
- outside the window, or if the window pointer 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.
-
+ 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 winsnstr perform wrapping. This is probably
- an error, since it makes this group of functions inconsis-
- tent. Also, no implementation of curses documents this
- inconsistency.
+ 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.
-