curs_instr(3X) 08 Jun 1992 curs_instr(3X)
NAME
cursinstr: inswstr, insnwstr, winswstr, winsnwstr, mvinswstr,
mvinsnwstr, mvwinswstr, mvwinsnwstr - insert wchart string before
character under the cursor in a curses window
SYNOPSIS
#include <curses.h>
int inswstr(wchart *wstr);
int insnwstr(wchart *wstr, int n);
int winswstr(WINDOW *win, wchart *wstr);
int winsnwstr(WINDOW *win, wchart *wstr, int n);
int mvinswstr(int y, int x, wchart *wstr);
int mvinsnwstr(int y, int x, wchart *wstr, int n);
int mvwinswstr(WINDOW *win, int y, int x, wchart *wstr);
int mvwinsnwstr(WINDOW *win, int y, int x, wchart *wstr, int n);
DESCRIPTION
With these routines, a wchart character string (as many wchart char-
acters as will fit on the line) is inserted before the character under
the cursor. All characters to the right of the cursor are moved to the
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). (This does not imply use of the hardware insert charac-
ter feature.) The four routines with n as the last argument insert at
most n wchart characters. If n<=0, then the entire string is
inserted.
If a character in wstr is a tab, newline, carriage return or back-
space, 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 wstr 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 the representation of the control char-
acter.
RETURN VALUE
All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion.
NOTES
The header file <curses.h> automatically includes the header files
<stdio.h> and <unctrl.h>.
Note that all but winsnwstr may be macros.
SEE ALSO
curses(3X), cursclear(3X), cursinwch(3X).
Page 1 Reliant UNIX 5.44 6, 198