ins_nwstr(3XC)

NAME

ins_nwstr, ins_wstr, mvins_nwstr, mvins_wstr, mvwins_nwstr, mvwins_nstr, wins_nwstr, wins_wstr − insert a wide character string

SYNOPSIS

#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);

ARGUMENTS

wstrIs a pointer to the string to be inserted.

nIs the number of characters not to exceed when inserting wstr. If n is less than 1, the entire string is inserted.

yIs the y (row) coordinate of the starting position of the string.

xIs the x (column) coordinate of the starting position of the string.

winIs 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(3XC) is automatically done before a newline.

RETURN VALUES

On success, these functions return OK. Otherwise, they return ERR.

ERRORS

None.

Museum

Related Articles