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

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2002-2010,2017 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_in_wch.3x,v 1.6 2017/11/21 00:53:44 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_in_wch 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1 class="no-header">curs_in_wch 3x</H1>
  42 <PRE>
  43 <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>                                                <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
  44
  45
  46
  47
  48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  49        <STRONG>in_wch</STRONG>,  <STRONG>mvin_wch</STRONG>, <STRONG>mvwin_wch</STRONG>, <STRONG>win_wch</STRONG> - extract a complex character and
  50        rendition from a window
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>in_wch(cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
  57        <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>wcval</EM><STRONG>);</STRONG>
  58        <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>wcval</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>win_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG>
  60
  61
  62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  63        These functions extract the complex character and  rendition  from  the
  64        current position in the named window into the <STRONG>cchar_t</STRONG> object referenced
  65        by wcval.
  66
  67
  68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  69        No errors are defined in the XSI Curses standard.  This  implementation
  70        checks  for null pointers, returns <STRONG>ERR</STRONG> in that case.  Also, the <EM>mv</EM> rou-
  71        tines check for error moving the cursor, returning <STRONG>ERR</STRONG>  in  that  case.
  72        Otherwise they return <STRONG>OK</STRONG>.
  73
  74        Functions  with  a  "mv"  prefix  first perform a cursor movement using
  75        <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
  76        the window pointer is null.
  77
  78
  79 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  80        Note that all of these routines may be macros.
  81
  82
  83 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  84        These functions are described in the XSI Curses standard, Issue 4.
  85
  86
  87 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  88        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
  89
  90
  91
  92                                                                <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
  93 </PRE>
  94 <div class="nav">
  95 <ul>
  96 <li><a href="#h2-NAME">NAME</a></li>
  97 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
  98 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
  99 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 100 <li><a href="#h2-NOTES">NOTES</a></li>
 101 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 102 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 103 </ul>
 104 </div>
 105 </BODY>
 106 </HTML>