|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON |
|
|
|
curs_addstr(3X) curs_addstr(3X)
addstr, addnstr, waddstr, waddnstr, mvaddstr, mvaddnstr,
mvwaddstr, mvwaddnstr - add a string of characters to a curses
window and advance cursor
#include <curses.h>
int addstr(const char *str);
int addnstr(const char *str, int n);
int waddstr(WINDOW *win, const char *str);
int waddnstr(WINDOW *win, const char *str, int n);
int mvaddstr(int y, int x, const char *str);
int mvaddnstr(int y, int x, const char *str, int n);
int mvwaddstr(WINDOW *win, int y, int x, const char *str);
int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n);
These functions write the (null-terminated) character string str
on the given window. It is similar to calling waddch once for
each byte in the string.
The mv functions perform cursor movement once, before writing any
characters. Thereafter, the cursor is advanced as a side-effect
of writing to the window.
The four functions with n as the last argument write at most n
bytes, or until a terminating null is reached. If n is -1, then
the entire string will be added.
All functions return the integer ERR upon failure and OK on suc‐
cess.
X/Open does not define any error conditions. This implementation
returns an error
• if the window pointer is null or
• if the string pointer is null or
• if the corresponding calls to waddch return an error.
Functions with a “mv” prefix first perform a cursor movement us‐
ing wmove, and return an error if the position is outside the
window, or if the window pointer is null. If an error is re‐
turned by the wmove, no characters are added to the window.
If an error is returned by waddch (e.g., because the window is
not large enough, or an illegal byte sequence was detected) only
part of the string may be added. Aside from that, there is a
special case in waddch where an error may be returned after suc‐
cessfully writing a character to the lower-right corner of a win‐
dow when scrollok(3X) is disabled.
All of these functions except waddnstr may be macros.
These functions are described in the XSI Curses standard, Issue
4.
curses(3X), curs_addch(3X).
This page is part of the ncurses (new curses) project. Informa‐
tion about the project can be found at
⟨https://www.gnu.org/software/ncurses/ncurses.html⟩. If you have
a bug report for this manual page, send it to
bug-ncurses-request@gnu.org. This page was obtained from the
project's upstream Git mirror of the CVS repository
⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14. (At that
time, the date of the most recent commit that was found in the
repository was 2023-03-12.) If you discover any rendering
problems in this HTML version of the page, or you believe there
is a better or more up-to-date source for the page, or you have
corrections or improvements to the information in this COLOPHON
(which is not part of the original manual page), send a mail to
man-pages@man7.org
curs_addstr(3X)
|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|