ncurses 6.2 - patch 20210626
[ncurses.git] / doc / html / man / curs_inch.3x.html
index 339e2458aa5fd1be5e43d48fcd555adf79243055..397664a1146cdaf82206371e01674694e6d30377 100644 (file)
 <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_inch 3X</TITLE>
+<TITLE>curs_inch 3x</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_inch 3X</H1>
+<H1 class="no-header">curs_inch 3x</H1>
 <PRE>
-<B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>                                                    <B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>
+<STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>                                                    <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>inch</B>,  <B>winch</B>,  <B>mvinch</B>,  <B>mvwinch</B> - get a character and attributes from a
-       <B>curses</B> window
+       <STRONG>inch</STRONG>,  <STRONG>winch</STRONG>,  <STRONG>mvinch</STRONG>,  <STRONG>mvwinch</STRONG> - get a character and attributes from a
+       <STRONG>curses</STRONG> window
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
-       <B>chtype</B> <B>inch(void);</B>
-       <B>chtype</B> <B>winch(WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG>
+       <STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
-       <B>chtype</B> <B>mvinch(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
-       <B>chtype</B> <B>mvwinch(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
+       <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
+       <STRONG>chtype</STRONG> <STRONG>mvwinch(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>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       These routines return the character, of type  <B>chtype</B>,  at  the  current
+       These routines return the character, of type  <STRONG>chtype</STRONG>,  at  the  current
        position  in  the  named  window.   If  any attributes are set for that
        position, their values are OR'ed into the  value  returned.   Constants
-       defined  in <B>&lt;curses.h&gt;</B> can be used with the <B>&amp;</B> (logical AND) operator to
+       defined  in <STRONG>&lt;curses.h&gt;</STRONG> can be used with the <STRONG>&amp;</STRONG> (logical AND) operator to
        extract the character or attributes alone.
 
 
 </PRE><H3><a name="h3-Attributes">Attributes</a></H3><PRE>
        The following bit-masks may  be  AND-ed  with  characters  returned  by
-       <B>winch</B>.
+       <STRONG>winch</STRONG>.
 
-       <B>A_CHARTEXT</B>     Bit-mask to extract character
-       <B>A_ATTRIBUTES</B>   Bit-mask to extract attributes
-       <B>A_COLOR</B>        Bit-mask to extract color-pair field information
+       <STRONG>A_CHARTEXT</STRONG>     Bit-mask to extract character
+       <STRONG>A_ATTRIBUTES</STRONG>   Bit-mask to extract attributes
+       <STRONG>A_COLOR</STRONG>        Bit-mask to extract color-pair field information
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
        Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       <B>wmove</B>, and return an error if the position is outside the window, or if
+       <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
        the window pointer is null.
 
-       The  <B>winch</B>  function  does  not  return an error if the window contains
+       The  <STRONG>winch</STRONG>  function  does  not  return an error if the window contains
        characters larger than 8-bits (255).  Only the low-order 8 bits of  the
-       character are used by <B>winch</B>.
+       character are used by <STRONG>winch</STRONG>.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        Very  old systems (before standardization) provide a different function
        with the same name:
 
-       <B>o</B>   The <B>winch</B> function was part of the  original  BSD  curses  library,
-           which   stored   a  7-bit  character  combined  with  the  <I>standout</I>
+       <STRONG>o</STRONG>   The <STRONG>winch</STRONG> function was part of the  original  BSD  curses  library,
+           which   stored   a  7-bit  character  combined  with  the  <EM>standout</EM>
            attribute.
 
-           In BSD curses, <B>winch</B> returned only the character  (as  an  integer)
-           with the <I>standout</I> attribute removed.
+           In BSD curses, <STRONG>winch</STRONG> returned only the character  (as  an  integer)
+           with the <EM>standout</EM> attribute removed.
 
-       <B>o</B>   System  V  curses  added support for several video attributes which
+       <STRONG>o</STRONG>   System  V  curses  added support for several video attributes which
            could be combined with characters in the window.
 
            Reflecting this improvement, the function was altered to return the
-           character combined with all video attributes in a <B>chtype</B> value.
+           character combined with all video attributes in a <STRONG>chtype</STRONG> value.
 
        X/Open Curses does not specify the size and layout of attributes, color
-       and character values in <B>chtype</B>; it is  implementation-dependent.   This
+       and character values in <STRONG>chtype</STRONG>; it is  implementation-dependent.   This
        implementation  uses 8 bits for character values.  An application using
        more bits,  e.g.,  a  Unicode  value,  should  use  the  wide-character
        equivalents to these functions.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <B><A HREF="curses.3X.html">curses(3X)</A></B>
-            gives an overview of the WINDOW and <B>chtype</B> data types.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
+            gives an overview of the WINDOW and <STRONG>chtype</STRONG> data types.
 
-       <B><A HREF="curs_attr.3X.html">curs_attr(3X)</A></B>
+       <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
             goes  into  more  detail,  pointing  out  portability problems and
-            constraints on the use of <B>chtype</B> for returning window information.
+            constraints on the use of <STRONG>chtype</STRONG> for returning window information.
 
-       <B><A HREF="curs_in_wch.3X.html">curs_in_wch(3X)</A></B>
+       <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
             describes comparable functions for the  wide-character  (ncursesw)
             library.
 
 
 
-                                                                 <B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>
+                                                                 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>