INSNSTR(3XCURSES)INSNSTR(3XCURSES)NAME
insnstr, insstr, mvinsnstr, mvinsstr, mvwinsnstr, mvwinsstr, winsnstr,
winsstr - insert a multibyte character string
SYNOPSIS
cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]
c89 [ flag... ] file... -lcurses [ library... ]
#include <curses.h>
int insnstr(const char *str, int n);
int insstr(const char *str);
int mvinsnstr(int y, int x, const char *str, int n);
int mvinsstr(int y, int x, const char *str);
int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);
int mvwinsstr(WINDOW *win, int y, int x, const char *str);
int winsnstr(WINDOW *win, const char *str, int n);
int winsstr(WINDOW *win, const char *str);
PARAMETERS
str
Is a pointer to the string to be inserted.
n
Is the number of characters not to exceed when inserting str.
If n is less than 1, the entire string is inserted.
y
Is the y (row) coordinate of the starting position of the
string.
x
Is the x (column) coordinate of the starting position of the
string.
win
Is a pointer to the window in which the string is to be
inserted.
DESCRIPTION
The insstr() function inserts str at the current cursor position of the
stdscr window. The winsstr() function performs the identical action,
but in window win. The mvinsstr() and mvwinsstr() functions insert
the character string at the starting position indicated by the x (col‐
umn) and y (row) parameters (the former to the stdscr window; the lat‐
ter to window win).
The insnstr(), winsnstr(), mvinsnstr(), and mvwinsnstr() functions
insert n characters to the window or as many as will fit on the line.
If n is less than 1, the entire string is inserted or as much of it as
fits on the line. The former two functions place the string at the
current cursor position; the latter two commands use the position
specified by the x and y parameters.
All characters to the right of inserted characters are moved to the
right. Characters that don't fit on the current line are discarded.
The cursor is left at the point of insertion.
If a character in str is a newline, carriage return, backspace, or tab,
the cursor is moved appropriately. The cursor is moved to the next tab
stop for each tab character (by default, tabs are eight characters
apart). If the character is a control character other than those previ‐
ously mentioned, the character is inserted using ^x notation, where x
is a printable character. clrtoeol(3XCURSES) is automatically done
before a newline.
RETURN VALUES
On success, these functions return OK. Otherwise, they return ERR.
ERRORS
None.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌────────────────────┬─────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├────────────────────┼─────────────────┤
│Interface Stability │ Standard │
├────────────────────┼─────────────────┤
│MT-Level │ Unsafe │
└────────────────────┴─────────────────┘
SEE ALSOaddchstr(3XCURSES), addstr(3XCURSES), clrtoeol(3XCURSES),
ins_nwstr(3XCURSES), insch(3XCURSES), libcurses(3XCURSES),
attributes(5), standards(5)
Jun 5, 2002 INSNSTR(3XCURSES)
