ins_wstr3ncurses
Insert a wide-character string in a curses window
Usage
#include <curses.h>
int ins_wstr(const wchar_t * wstr); int wins_wstr(WINDOW * win, const wchar_t * wstr); int mvins_wstr(int y, int x, const wchar_t * wstr); int mvwins_wstr(WINDOW * win, int y, int x,
const wchar_t * wstr);
int ins_nwstr(const wchar_t * wstr, int n); int wins_nwstr(WINDOW * win, const wchar_t * wstr, int n); int mvins_nwstr(int y, int x, const wchar_t * wstr, int n); int mvwins_nwstr(WINDOW * win, int y, int x,
const wchar_t * wstr, int n);
Overview
wins_wstr inserts a wide-character string wstr before the character at the cursor in window win as if by calling wins_wch(3NCURSES) for each wchar_t in wstr. No line wrapping is performed. Characters to the right of the cursor are shifted right; those at the right edge of the window may be lost. wins_wstr stops inserting if it would have to wrap to the next line to write the next wchar_t in wstr. The cursor position does not change (after moving to (y, x), if specified). wins_nwstr does the same, but inserts at most n characters, or as many as possible (up to the end of the line) if n is negative. ncurses(3NCURSES) describes the variants of these functions.
Return value
These functions return OK on success and ERR on failure.
In ncurses, they return ERR if
•
|
win |
|---|---|
•
|
wstr |
•
|
the first wide character in wstr is a non-spacing character, |
•
|
an internal wins_wch(3NCURSES) call returns ERR. |
Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.
Notes
All of these functions except wins_nwstr may be implemented as macros.
Extensions
ins_nwstr, wins_nwstr, mvins_nwstr, and mvwins_nwstr's acceptance of negative n values is an ncurses extension.
Portability
Applications employing ncurses extensions should condition their use on the visibility of the NCURSES_VERSION preprocessor macro.
X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.
X/Open Curses does not specify what happens if a non-spacing character follows a control character.
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 such as waddwstr, and differs from the SVr4 curses and Solaris xcurses implementations. Nevertheless, Issue 7 retains the language.
Releases
11 releases since Debian 3.1 (Sarge); the text changed 7 times.