INS_NWSTR(3XCURSES) X/Open Curses Library Functions INS_NWSTR(3XCURSES)
NAME
ins_nwstr, ins_wstr, mvins_nwstr, mvins_wstr, mvwins_nwstr,
mvwins_wstr, wins_nwstr, wins_wstr - insert a wide 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 ins_nwstr(
const wchar_t *wstr,
int n);
int ins_wstr(
const wchar_t *wstr);
int mvins_nwstr(
int y,
int x,
const wchar_t *wstr,
int n);
int mvins_wstr(
int y,
int x,
const wchar_t *wstr);
int mvwins_nwstr(
WINDOW *win,
int y,
int x,
const wchar_t *wstr,
int n);
int mvwins_wstr(
WINDOW *win,
int y,
int x,
const wchar_t *wstr);
int wins_nwstr(
WINDOW *win,
const wchar_t *wstr,
int n);
int wins_wstr(
WINDOW *win,
const wchar_t *wstr);
PARAMETERS
wstr Is a pointer to the string to be inserted.
n Is the number of characters not to exceed when inserting
wstr. 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
ins_wstr() function inserts
wstr at the current cursor position
of the
stdscr window. The
wins_wstr() function performs the identical
action, but in window
win. The
mvins_wstr() and
mvwins_wstr() functions insert
wstr string at the starting position indicated by
the
x (column) and
y (row) parameters (the former in the
stdscr window; the latter in window
win).
The
ins_nwstr(),
wins_nwstr(),
mvins_nwstr(), and
mvwins_nwstr() 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
wstr 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 previously 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(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+
SEE ALSO
add_wchnstr(3XCURSES),
addnwstr(3XCURSES),
clrtoeol(3XCURSES),
ins_wch(3XCURSES),
insnstr(3XCURSES),
libcurses(3XCURSES),
attributes(7),
standards(7) June 5, 2002 INS_NWSTR(3XCURSES)
