- These routines insert the character ch before the character under the
- cursor. All characters to the right of the cursor are moved one space
- to the right, with the possibility of the rightmost character on the
- line being lost. The insertion operation does not change the cursor
- position.
+ These functions insert the curses character ch at the cursor in the
+ specified window win (or stdscr). The character previously at the
+ cursor and any to its right move one cell to the right; the rightmost
+ character on the line is discarded. The cursor does not advance.
- These routines return the integer ERR upon failure and an OK (SVr4
- specifies only "an integer value other than ERR") upon successful
- completion.
+ These functions return OK on success and ERR on failure.
+
+ Functions taking a WINDOW pointer argument fail if the 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.
+ Functions prefixed with "mv" first perform cursor movement using wmove
+ and fail if the position (y, x) is outside the window.
- These routines do not necessarily imply use of a hardware insert
- character feature.
+ A terminal's insert_character (ich1) capability is not necessarily
+ employed.
- Note that insch, mvinsch, and mvwinsch may be macros.
+ insch, mvinsch, and mvwinsch may be implemented as macros.
- These functions are described in the XSI Curses standard, Issue 4.
+ X/Open Curses, Issue 4, describes these functions.
+
+ SVr4 describes successful return values only as "an integer value other
+ than ERR".