add_wchnstr(3xcurses)

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

NAME

6       add_wchnstr,  add_wchstr,  mvadd_wchnstr, mvadd_wchstr, mvwadd_wchnstr,
7       mvwadd_wchstr, wadd_wchnstr, wadd_wchstr - copy  a  string  of  complex
8       characters (with renditions) to a window
9

SYNOPSIS

11       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
12        -R  /usr/xpg4/lib  -lcurses  [ library... ]
13
14       c89 [ flag... ] file... -lcurses [ library ... ]
15
16       #include <curses.h>
17
18       int add_wchnstr(const cchar_t *wchstr, int n);
19
20
21       int add_wchstr(const cchar_t *wchstr);
22
23
24       int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
25
26
27       int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
28
29
30       int mvwadd_wchnstr(WINDOW *win, int y, int x,
31            const cchar_t *wchstr, int n);
32
33
34       int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);
35
36
37       int wadd_wchstr(WINDOW *win, const cchar_t *wchstr);
38
39
40       int wadd_wchnstr(WINDOW *win, const cchar_t *wchstr, int n);
41
42

DESCRIPTION

44       The  add_wchstr()  function  copies the string of cchar_t characters to
45       the stdscr window at the current cursor position.   The  mvadd_wchstr()
46       and mvwadd_wchstr() functions copy the  string to the starting position
47       indicated by the x (column) and y  (row) parameters (the former to  the
48       stdscr window; the latter to window win).  The wadd_wchstr() is identi‐
49       cal to add_wchstr(), but writes  to the window specified by win.
50
51
52       The add_wchnstr(), wadd_wchnstr(), mvadd_wchnstr(),  and   mvwadd_wchn‐
53       str()  functions  write n characters to the window,  or as many as will
54       fit on the line. If n is less than 0, the entire string is written,  or
55       as much of it as  fits on the line.  The former two functions place the
56       string at the current cursor position; the  latter two commands use the
57       position specified by the x and y parameters.
58
59
60       These  functions  differ from the addwstr(3XCURSES) set of functions in
61       two important respects. First, these functions do not advance the  cur‐
62       sor after writing the  string to the window. Second, the current window
63       rendition (that is, the combination of attributes  and color  pair)  is
64       not  combined  with  the  character;  only  those  attributes that  are
65       already part of the cchar_t character are used.
66

PARAMETERS

68       wchstr    Is a pointer to the cchar_t string to be copied to  the  win‐
69                 dow.
70
71
72       n         Is the maximum number of characters to be copied from wchstr.
73                 If n is less than 0, the entire string is written or as  much
74                 of it as fits on the line.
75
76
77       y         Is  the y (row) coordinate of the starting position of wchstr
78                 in the window.
79
80
81       x         Is the x (column) coordinate of the starting position of wch‐
82                 str  in the window.
83
84
85       win       Is  a  pointer  to  the  window  to which the string is to be
86                 copied.
87
88

RETURN VALUES

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

ERRORS

93       None.
94

ATTRIBUTES

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