doc/html/man/curs_delch.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2006,2010 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_delch.3x,v 1.35 2024/05/11 20:39:53 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_delch 3x 2024-05-11 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_delch 3x 2024-05-11 ncurses 6.5 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>                   Library calls                  <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>delch</STRONG>,  <STRONG>wdelch</STRONG>,  <STRONG>mvdelch</STRONG>,  <STRONG>mvwdelch</STRONG>  - delete a character from a <EM>curses</EM>
  51        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>delch(void);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>wdelch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>mvdelch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>mvwdelch(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>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        <STRONG>wdelch</STRONG> deletes the character at the cursor position in <EM>win</EM>.   It  moves
  65        all  characters to the right of the cursor on the same line to the left
  66        one position and replaces the contents of the rightmost position on the
  67        line  with  the  window's blank character; see <STRONG><A HREF="curs_bkgd.3x.html">bkgd(3x)</A></STRONG> (wide-character
  68        API users: <STRONG><A HREF="curs_bkgrnd.3x.html">bkgrnd(3x)</A></STRONG>).  The cursor position  does  not  change  (after
  69        moving to (<EM>y</EM>, <EM>x</EM>), if specified).  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of
  70        this function.
  71
  72
  73 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  74        These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
  75
  76        Functions taking a <EM>WINDOW</EM> pointer argument fail if the pointer is <STRONG>NULL</STRONG>.
  77
  78        Functions prefixed with "mv" first perform cursor movement and fail  if
  79        the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
  80
  81
  82 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  83        <STRONG>delch</STRONG>, <STRONG>mvdelch</STRONG>, and <STRONG>mvwdelch</STRONG> may be implemented as macros.
  84
  85        A  terminal's  <STRONG>delete_character</STRONG>  (<STRONG>dch1</STRONG>)  capability  is not necessarily
  86        employed.
  87
  88
  89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  90        X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
  91        error conditions for them.
  92
  93        SVr4  <EM>curses</EM>  describes  a  successful return value only as "an integer
  94        value other than <STRONG>ERR</STRONG>".
  95
  96
  97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  98        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
  99
 100
 101
 102 ncurses 6.5                       2024-05-11                    <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
 103 </PRE>
 104 <div class="nav">
 105 <ul>
 106 <li><a href="#h2-NAME">NAME</a></li>
 107 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 108 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 109 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 110 <li><a href="#h2-NOTES">NOTES</a></li>
 111 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 112 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 113 </ul>
 114 </div>
 115 </BODY>
 116 </HTML>