insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, mvwinsstr,
- mvwinsnstr - insert string before cursor in a curses window
+ mvwinsnstr - insert a string in a curses window
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.
+ 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.
- Special characters are handled as in addch.
+ 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 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
- descriptions.
+ All functions return the integer ERR upon failure and OK on success.
+
+ X/Open Curses does not specify any error conditions. This
+ implementation returns ERR
+
+ o if the win parameter is null or
- 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.
+ o if the str parameter is null or
- 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.
+ o the winsch(3x) function returns ERR.
+
+ 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 the XSI Curses standard, Issue 4,
- which adds const qualifiers to the arguments.
+ X/Open Curses, Issue 4 describes these functions. It specifies no
+ error conditions for them.
+
+ Issue 4 distinguished insnstr and winsnstr by stating they "do not
+ perform wrapping". This was probably an error, since it makes this
+ group of functions inconsistent. No implementation of curses documents
+ this inconsistency, and Issue 7 removed it.
- 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.
+ Issue 4 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 curses and Solaris xcurses
+ implementations. Nevertheless, Issue 7 retains it.