diff options
Diffstat (limited to 'doc/html/man/curs_inwstr.3x.html')
-rw-r--r-- | doc/html/man/curs_inwstr.3x.html | 65 |
1 files changed, 42 insertions, 23 deletions
diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index 3110967aeebe..6c79b595fbeb 100644 --- a/doc/html/man/curs_inwstr.3x.html +++ b/doc/html/man/curs_inwstr.3x.html @@ -1,6 +1,6 @@ -<!-- +<!-- **************************************************************************** - * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 2018-2023,2024 Thomas E. Dickey * * Copyright 2002-2012,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,28 +27,28 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_inwstr.3x,v 1.14 2020/10/17 23:22:11 tom Exp @ + * @Id: curs_inwstr.3x,v 1.41 2024/04/20 21:20:07 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> -<TITLE>curs_inwstr 3x</TITLE> +<TITLE>curs_inwstr 3x 2024-04-20 ncurses 6.5 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + </HEAD> <BODY> -<H1 class="no-header">curs_inwstr 3x</H1> +<H1 class="no-header">curs_inwstr 3x 2024-04-20 ncurses 6.5 Library calls</H1> <PRE> -<STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> +<STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> <STRONG>inwstr</STRONG>, <STRONG>innwstr</STRONG>, <STRONG>winwstr</STRONG>, <STRONG>winnwstr</STRONG>, <STRONG>mvinwstr</STRONG>, <STRONG>mvinnwstr</STRONG>, <STRONG>mvwinwstr</STRONG>, - <STRONG>mvwinnwstr</STRONG> - get a string of <STRONG>wchar_t</STRONG> characters from a curses window + <STRONG>mvwinnwstr</STRONG> - get a wide-character string from a <EM>curses</EM> window </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> @@ -67,7 +67,7 @@ </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> These routines return a string of <STRONG>wchar_t</STRONG> wide characters in <EM>wstr</EM>, - extracted starting at the current cursor position in the named window. + starting at the current cursor position in the named window. The four functions with <EM>n</EM> as the last argument return a leading substring at most <EM>n</EM> characters long (exclusive of the trailing NUL). @@ -78,39 +78,58 @@ character, an error is generated. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + All routines return <STRONG>ERR</STRONG> upon failure. Upon successful completion, the + *<STRONG>inwstr</STRONG> routines return <STRONG>OK</STRONG>, and the *<STRONG>innwstr</STRONG> routines return the number + of characters read into the string. + + X/Open defines no error conditions. This implementation returns an + error + + <STRONG>o</STRONG> if the <EM>win</EM> parameter is null or + + <STRONG>o</STRONG> if the <EM>wstr</EM> parameter is null, or + + <STRONG>o</STRONG> if no characters could be read. + + Functions prefixed with "mv" first perform cursor movement and fail if + the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries. + + </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> All routines except <STRONG>winnwstr</STRONG> may be macros. - Each cell in the window holds a complex character (i.e., base- and - combining-characters) together with attributes and color. These - functions store only the wide characters, ignoring attributes and - color. Use <STRONG>in_wchstr</STRONG> to return the complex characters from a window. + Each cell in the window holds a complex character (a spacing character + and zero or more non-spacing characters) together with attributes and + color. These functions store only the wide characters, ignoring + attributes and color. Use <STRONG>in_wchstr</STRONG> to return the complex characters + from a window. + Reading a line that overflows the array pointed to by <EM>wstr</EM> with <STRONG>inwstr</STRONG>, + <STRONG>mvinwstr</STRONG>, <STRONG>mvwinwstr</STRONG> or <STRONG>winwstr</STRONG> causes undefined results. Therefore, + the use of <STRONG>innwstr</STRONG>, <STRONG>mvinnwstr</STRONG>, <STRONG>mvwinnwstr</STRONG>, or <STRONG>winnwstr</STRONG> is recommended. -</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> - All routines return <STRONG>ERR</STRONG> upon failure. Upon successful completion, the - *<STRONG>inwstr</STRONG> routines return <STRONG>OK</STRONG>, and the *<STRONG>innwstr</STRONG> routines return the number - of characters read into the string. - 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. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These functions are described in X/Open Curses, Issue 4. </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> - <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>, <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>, + <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> - <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> +ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> </PRE> <div class="nav"> <ul> <li><a href="#h2-NAME">NAME</a></li> <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> -<li><a href="#h2-NOTES">NOTES</a></li> <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> </ul> </div> |