wins_wstr(3xcurses)

1ins_nwstr(3XCURSES)     X/Open Curses Library Functions    ins_nwstr(3XCURSES)
2
3
4

NAME

6       ins_nwstr,    ins_wstr,    mvins_nwstr,    mvins_wstr,    mvwins_nwstr,
7       mvwins_wstr, wins_nwstr, wins_wstr - insert a wide character string
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       int ins_nwstr(const wchar_t *wstr, int n);
18
19
20       int ins_wstr(const wchar_t *wstr);
21
22
23       int mvins_nwstr(int y, int x, const wchar_t *wstr, int n);
24
25
26       int mvins_wstr(int y, int x, const wchar_t *wstr);
27
28
29       int mvwins_nwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);
30
31
32       int mvwins_wstr(WINDOW *win, int y, int x, const wchar_t *wstr);
33
34
35       int wins_nwstr(WINDOW *win, const wchar_t *wstr, int n);
36
37
38       int wins_wstr(WINDOW *win, const wchar_t *wstr);
39
40

PARAMETERS

42       wstr    Is a pointer to the string to be inserted.
43
44
45       n       Is the number of characters not to exceed when inserting  wstr.
46               If n is less than 1, the entire string is inserted.
47
48
49       y       Is  the  y  (row)  coordinate  of  the starting position of the
50               string.
51
52
53       x       Is the x (column) coordinate of the starting  position  of  the
54               string.
55
56
57       win     Is  a  pointer  to  the  window  in  which  the string is to be
58               inserted.
59
60

DESCRIPTION

62       The ins_wstr() function inserts wstr at the current cursor  position of
63       the  stdscr  window.  The  wins_wstr()  function performs the identical
64       action, but in window  win.  The mvins_wstr() and  mvwins_wstr()  func‐
65       tions  insert  wstr  string at the starting position indicated by the x
66       (column) and y  (row) parameters (the former in the stdscr window;  the
67       latter in window win).
68
69
70       The ins_nwstr(), wins_nwstr(), mvins_nwstr(), and  mvwins_nwstr() func‐
71       tions insert n characters to the window or as  many as will fit on  the
72       line.  If n is less than 1, the entire string is inserted or as much of
73       it as  fits on the line.  The former two functions place the string  at
74       the  current cursor position; the  latter two commands use the position
75       specified by the x and y parameters.
76
77
78       All characters to the right of inserted characters  are  moved  to  the
79       right.   Characters  that  don't fit on the current line are discarded.
80       The cursor is left at the point of insertion.
81
82
83       If a character in wstr is a newline,  carriage  return,  backspace,  or
84       tab,   the  cursor  is moved appropriately.  The cursor is moved to the
85       next tab stop for each tab character (by default, tabs are eight  char‐
86       acters apart). If the character is a control character other than those
87       previously mentioned, the character  is  inserted  using  ^x  notation,
88       where  x is a printable character.  clrtoeol(3XCURSES) is automatically
89       done before a newline.
90

RETURN VALUES

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

ERRORS

95       None.
96

ATTRIBUTES

98       See attributes(5) for descriptions of the following attributes:
99
100
101
102
103       ┌─────────────────────────────┬─────────────────────────────┐
104       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
105       ├─────────────────────────────┼─────────────────────────────┤
106       │Interface Stability          │Standard                     │
107       ├─────────────────────────────┼─────────────────────────────┤
108       │MT-Level                     │Unsafe                       │
109       └─────────────────────────────┴─────────────────────────────┘
110