waddchstr(3xcurses)

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

NAME

6       addchstr,  addchnstr,  mvaddchstr, mvaddchnstr, mvwaddchnstr, mvwaddch‐
7       str, waddchstr, waddchnstr - copy a character string (with  renditions)
8       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 addchstr(const chtype *chstr);
19
20
21       int addchnstr(const chtype *chstr, int n);
22
23
24       int mvaddchnstr(int y, int x, const chtype *chstr, int n);
25
26
27       int mvaddchstr(int y, int x, const chtype *chstr);
28
29
30       int mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr, int n);
31
32
33       int mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);
34
35
36       int waddchstr(WINDOW *win, const chtype *chstr);
37
38
39       int waddchnstr(WINDOW *win, const chtype *chstr, int n);
40
41

DESCRIPTION

43       The  addchstr() function copies the chtype character string to the std‐
44       scr window at the current cursor position.  The mvaddchstr() and mvwad‐
45       dchstr()  functions copy the  character string to the starting position
46       indicated by the x (column)  and y (row) parameters (the former to  the
47       stdscr  window;  the latter to window win).  The waddchstr() is identi‐
48       cal to addchstr(), but writes  to the window specified by win.
49
50
51       The addchnstr(), waddchnstr(), mvaddchnstr(), and  mvwaddchnstr() func‐
52       tions  write n characters to the window,  or as many as will fit on the
53       line. If n is less than 0, the entire string is written, or as much  of
54       it  as  fits on the line.  The former two functions place the string at
55       the current cursor position; the  latter two commands use the  position
56       specified by the x and y parameters.
57
58
59       These  functions  differ  from the addstr(3XCURSES) set of functions in
60       two important respects.  First, these functions do not advance the cur‐
61       sor  after writing the string to the window. Second, the current window
62       rendition is not combined with the character;  only the attributes that
63       are already part of the chtype character  are used.
64

PARAMETERS

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

RETURN VALUES

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

ERRORS

90       None.
91

ATTRIBUTES

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