diff options
Diffstat (limited to 'doc/html/man/curs_addstr.3x.html')
| -rw-r--r-- | doc/html/man/curs_addstr.3x.html | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index 243afe4..71abb99 100644 --- a/doc/html/man/curs_addstr.3x.html +++ b/doc/html/man/curs_addstr.3x.html @@ -1,4 +1,4 @@ -<!-- +<!-- **************************************************************************** * Copyright 2019,2020 Thomas E. Dickey * * Copyright 1998-2012,2017 Free Software Foundation, Inc. * @@ -27,7 +27,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_addstr.3x,v 1.20 2020/02/02 23:34:34 tom Exp @ + * @Id: curs_addstr.3x,v 1.23 2020/10/17 23:11:02 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> @@ -59,6 +59,7 @@ <STRONG>int</STRONG> <STRONG>addnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> <STRONG>int</STRONG> <STRONG>waddstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> <STRONG>int</STRONG> <STRONG>waddnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> <STRONG>int</STRONG> <STRONG>mvaddnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> <STRONG>int</STRONG> <STRONG>mvwaddstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> @@ -67,16 +68,16 @@ </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> These functions write the (null-terminated) character string <EM>str</EM> on the - given window. It is similar to calling <STRONG>waddch</STRONG> once for each character - in the string. + given window. It is similar to calling <STRONG>waddch</STRONG> once for each byte in + the string. The <EM>mv</EM> functions perform cursor movement once, before writing any char- acters. Thereafter, the cursor is advanced as a side-effect of writing to the window. - The four functions with <EM>n</EM> as the last argument write at most <EM>n</EM> charac- - ters, or until a terminating null is reached. If <EM>n</EM> is -1, then the en- - tire string will be added. + The four functions with <EM>n</EM> as the last argument write at most <EM>n</EM> bytes, + or until a terminating null is reached. If <EM>n</EM> is -1, then the entire + string will be added. </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> @@ -93,7 +94,15 @@ Functions with a "mv" prefix first perform a cursor movement using <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if - the window pointer is null. + the window pointer is null. If an error is returned by the <STRONG>wmove</STRONG>, no + characters are added to the window. + + If an error is returned by <STRONG>waddch</STRONG> (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 + <STRONG>waddch</STRONG> where an error may be returned after successfully writing a + character to the lower-right corner of a window when <STRONG>scrollok</STRONG> is dis- + abled. </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> |