diff options
Diffstat (limited to 'doc/html/man/curs_getcchar.3x.html')
| -rw-r--r-- | doc/html/man/curs_getcchar.3x.html | 108 |
1 files changed, 54 insertions, 54 deletions
diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index 6a45e0ac8121..c1edf2841c36 100644 --- a/doc/html/man/curs_getcchar.3x.html +++ b/doc/html/man/curs_getcchar.3x.html @@ -1,6 +1,6 @@ -<!-- +<!-- **************************************************************************** - * Copyright 2019,2020 Thomas E. Dickey * + * Copyright 2019-2023,2024 Thomas E. Dickey * * Copyright 2001-2015,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,43 +27,43 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_getcchar.3x,v 1.24 2020/02/02 23:34:34 tom Exp @ + * @Id: curs_getcchar.3x,v 1.49 2024/04/20 18:55:09 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_getcchar 3x</TITLE> +<TITLE>curs_getcchar 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_getcchar 3x</H1> +<H1 class="no-header">curs_getcchar 3x 2024-04-20 ncurses 6.5 Library calls</H1> <PRE> -<STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> +<STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> - <STRONG>getcchar</STRONG>, <STRONG>setcchar</STRONG> - Get a wide character string and rendition from a - <STRONG>cchar_t</STRONG> or set a <STRONG>cchar_t</STRONG> from a wide-character string + <STRONG>getcchar</STRONG>, <STRONG>setcchar</STRONG> - convert between a wide-character string and a + <EM>curses</EM> complex character </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>int</STRONG> <STRONG>getcchar(</STRONG> - <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG> - <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG> + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG> + <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wc</EM><STRONG>,</STRONG> <STRONG>attr_t</STRONG> <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <STRONG>*</STRONG><EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG> <STRONG>int</STRONG> <STRONG>setcchar(</STRONG> - <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG> - <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG> + <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG> + <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wc</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG> @@ -73,79 +73,79 @@ </PRE><H3><a name="h3-getcchar">getcchar</a></H3><PRE> The <STRONG>getcchar</STRONG> function gets a wide-character string and rendition from a - <STRONG>cchar_t</STRONG> argument. When <EM>wch</EM> is not a null pointer, the <STRONG>getcchar</STRONG> - function does the following: + <STRONG>cchar_t</STRONG> argument. When <EM>wc</EM> is not a null pointer, the <STRONG>getcchar</STRONG> function + does the following: - <STRONG>o</STRONG> Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM> + <STRONG>o</STRONG> Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wch</EM> <STRONG>o</STRONG> Stores the character attributes in the location pointed to by <EM>attrs</EM> - <STRONG>o</STRONG> Stores the color-pair in the location pointed to by <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> + <STRONG>o</STRONG> Stores the color pair in the location pointed to by <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> - <STRONG>o</STRONG> Stores the wide-character string, characters referenced by <EM>wcval</EM>, - into the array pointed to by <EM>wch</EM>. + <STRONG>o</STRONG> Stores the wide-character string, characters referenced by <EM>wch</EM>, + into the array pointed to by <EM>wc</EM>. - When <EM>wch</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the following: + When <EM>wc</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the following: - <STRONG>o</STRONG> Obtains the number of wide characters pointed to by <EM>wcval</EM> + <STRONG>o</STRONG> Obtains the number of wide characters pointed to by <EM>wch</EM> <STRONG>o</STRONG> Does not change the data referenced by <EM>attrs</EM> or <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> </PRE><H3><a name="h3-setcchar">setcchar</a></H3><PRE> - The <STRONG>setcchar</STRONG> function initializes the location pointed to by <EM>wcval</EM> by + The <STRONG>setcchar</STRONG> function initializes the location pointed to by <EM>wch</EM> by using: <STRONG>o</STRONG> The character attributes in <EM>attrs</EM> <STRONG>o</STRONG> The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> - <STRONG>o</STRONG> The wide-character string pointed to by <EM>wch</EM>. The string must be + <STRONG>o</STRONG> The wide-character string pointed to by <EM>wc</EM>. The string must be L'\0' terminated, contain at most one spacing character, which must be the first. - Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters may follow. Additional - nonspacing characters are ignored. + Up to <STRONG>CCHARW_MAX</STRONG>-1 non-spacing characters may follow. Additional + non-spacing characters are ignored. The string may contain a single control character instead. In that - case, no nonspacing characters are allowed. + case, no non-spacing characters are allowed. -</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> - X/Open Curses documents the <EM>opts</EM> argument as reserved for future use, - saying that it must be null. This implementation uses that parameter - in ABI 6 for the functions which have a color-pair parameter to support - extended color pairs: +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + When <EM>wc</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of wide + characters referenced by <EM>wch</EM>, including one for a trailing null. - <STRONG>o</STRONG> For functions which modify the color, e.g., <STRONG>setcchar</STRONG>, if <EM>opts</EM> is - set it is treated as a pointer to <STRONG>int</STRONG>, and used to set the color - pair instead of the <STRONG>short</STRONG> pair parameter. + When <EM>wc</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon successful + completion, and <STRONG>ERR</STRONG> otherwise. - <STRONG>o</STRONG> For functions which retrieve the color, e.g., <STRONG>getcchar</STRONG>, if <EM>opts</EM> is - set it is treated as a pointer to <STRONG>int</STRONG>, and used to retrieve the - color pair as an <STRONG>int</STRONG> value, in addition retrieving it via the - standard pointer to <STRONG>short</STRONG> parameter. + Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Otherwise, it returns + <STRONG>ERR</STRONG>. </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> - The <EM>wcval</EM> argument may be a value generated by a call to <STRONG>setcchar</STRONG> or by - a function that has a <STRONG>cchar_t</STRONG> output argument. If <EM>wcval</EM> is constructed - by any other means, the effect is unspecified. + The <EM>wch</EM> argument may be a value generated by a call to <STRONG>setcchar</STRONG> or by a + function that has a <STRONG>cchar_t</STRONG> output argument. If <EM>wch</EM> is constructed by + any other means, the effect is unspecified. -</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> - When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of wide - characters referenced by <EM>wcval</EM>, including one for a trailing null. +</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> + X/Open Curses documents the <EM>opts</EM> argument as reserved for future use, + saying that it must be null. This implementation uses that parameter + in ABI 6 for the functions which have a color pair parameter to support + extended color pairs: - When <EM>wch</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon successful - completion, and <STRONG>ERR</STRONG> otherwise. + <STRONG>o</STRONG> For functions which modify the color, e.g., <STRONG>setcchar</STRONG>, if <EM>opts</EM> is + set it is treated as a pointer to <STRONG>int</STRONG>, and used to set the color + pair instead of the <STRONG>short</STRONG> pair parameter. - Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Otherwise, it returns - <STRONG>ERR</STRONG>. + <STRONG>o</STRONG> For functions which retrieve the color, e.g., <STRONG>getcchar</STRONG>, if <EM>opts</EM> is + set it is treated as a pointer to <STRONG>int</STRONG>, and used to retrieve the + color pair as an <STRONG>int</STRONG> value, in addition retrieving it via the + standard pointer to <STRONG>short</STRONG> parameter. </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> - The <STRONG>CCHARW_MAX</STRONG> symbol is specific to ncurses. X/Open Curses does not + The <STRONG>CCHARW_MAX</STRONG> symbol is specific to <EM>ncurses</EM>. X/Open Curses does not provide details for the layout of the <STRONG>cchar_t</STRONG> structure. It tells what data are stored in it: @@ -174,7 +174,7 @@ <STRONG>o</STRONG> HP-UX 10 uses an opaque structure with 28 bytes, which is large enough for the 6 <STRONG>wchar_t</STRONG> values. - <STRONG>o</STRONG> Solaris xpg4 curses uses a single array of 6 <STRONG>wchar_t</STRONG> values. + <STRONG>o</STRONG> Solaris <EM>xpg4</EM> curses uses a single array of 6 <STRONG>wchar_t</STRONG> values. This implementation's <STRONG>cchar_t</STRONG> was defined in 1995 using <STRONG>5</STRONG> for the total of spacing and non-spacing characters (<STRONG>CCHARW_MAX</STRONG>). That was probably @@ -192,11 +192,11 @@ </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> - Functions: <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG>wcwidth(3)</STRONG>. + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG>wcwidth(3)</STRONG> - <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> +ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> </PRE> <div class="nav"> <ul> @@ -208,9 +208,9 @@ <li><a href="#h3-setcchar">setcchar</a></li> </ul> </li> -<li><a href="#h2-EXTENSIONS">EXTENSIONS</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-EXTENSIONS">EXTENSIONS</a></li> <li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> </ul> |