doc/html/man/curs_in_wch.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 2002-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_in_wch.3x,v 1.33 2024/05/18 20:19:38 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_in_wch 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_in_wch 3x 2024-05-18 ncurses 6.5 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>                  Library calls                 <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>in_wch</STRONG>,  <STRONG>mvin_wch</STRONG>,  <STRONG>mvwin_wch</STRONG>, <STRONG>win_wch</STRONG> - get a <EM>curses</EM> complex character
  51        from a window
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>in_wch(cchar_t</STRONG> <STRONG>*</STRONG> <EM>wch</EM><STRONG>);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>win_wch(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG> <EM>wch</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>mvin_wch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG> <EM>wch</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>mvwin_wch(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>cchar_t</STRONG> <STRONG>*</STRONG> <EM>wch</EM><STRONG>);</STRONG>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        <STRONG>win_wch</STRONG> copies the <EM>curses</EM> complex character at the cursor  position  in
  65        <EM>win</EM>  into  <EM>wch</EM>.   Use  <STRONG><A HREF="curs_getcchar.3x.html">getcchar(3x)</A></STRONG>  to  extract  its  character  code,
  66        attributes, and  color  pair  identifier.   <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>  describes  the
  67        variants of this function.
  68
  69
  70 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  71        These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
  72
  73        In <EM>ncurses</EM>, <STRONG>win_wch</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is <STRONG>NULL</STRONG>.
  74
  75        Functions  prefixed with "mv" first perform cursor movement and fail if
  76        the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
  77
  78
  79 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  80        <STRONG>in_wch</STRONG>, <STRONG>mvin_wch</STRONG>, and <STRONG>mvwin_wch</STRONG> may be implemented as macros.
  81
  82        Unlike <STRONG><A HREF="curs_inch.3x.html">winch(3x)</A></STRONG>, <STRONG>win_wch</STRONG> and its  variants  store  the  value  of  the
  83        retrieved  character  in  an  additional  <EM>wch</EM>  parameter instead of the
  84        return value.
  85
  86
  87 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  88        X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
  89        error conditions for them.
  90
  91
  92 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  93        <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>  describes comparable functions of the <EM>ncurses</EM> library in
  94        its non-wide-character configuration.
  95
  96        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
  97
  98
  99
 100 ncurses 6.5                       2024-05-18                   <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
 101 </PRE>
 102 <div class="nav">
 103 <ul>
 104 <li><a href="#h2-NAME">NAME</a></li>
 105 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 106 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 107 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 108 <li><a href="#h2-NOTES">NOTES</a></li>
 109 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 110 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 111 </ul>
 112 </div>
 113 </BODY>
 114 </HTML>