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

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 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.11 2010/12/04 18:36:44 tom Exp @
  31 -->
  32 <HTML>
  33 <HEAD>
  34 <TITLE>curs_delch 3x</TITLE>
  35 <link rev=made href="mailto:bug-ncurses@gnu.org">
  36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37 </HEAD>
  38 <BODY>
  39 <H1>curs_delch 3x</H1>
  40 <HR>
  41 <PRE>
  42 <!-- Manpage converted by man2html 3.0.1 -->
  43 <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>                                           <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
  44
  45
  46
  47
  48 </PRE>
  49 <H2>NAME</H2><PRE>
  50        <STRONG>delch</STRONG>,  <STRONG>wdelch</STRONG>, <STRONG>mvdelch</STRONG>, <STRONG>mvwdelch</STRONG> - delete character under
  51        the cursor in a <STRONG>curses</STRONG> window
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>delch(void);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>wdelch(WINDOW</STRONG> <STRONG>*win);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>mvdelch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>mvwdelch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
  62
  63
  64 </PRE>
  65 <H2>DESCRIPTION</H2><PRE>
  66        These routines delete the character under the cursor;  all
  67        characters to the right of the cursor on the same line are
  68        moved to the left one position and the last  character  on
  69        the line is filled with a blank.  The cursor position does
  70        not change (after moving to <EM>y</EM>, <EM>x</EM>,  if  specified).   (This
  71        does  not  imply use of the hardware delete character fea-
  72        ture.)
  73
  74
  75 </PRE>
  76 <H2>RETURN VALUE</H2><PRE>
  77        All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
  78        (SVr4  specifies  only  "an integer value other than <STRONG>ERR</STRONG>")
  79        upon successful completion.
  80
  81        Functions with a "mv" prefix first perform a cursor  move-
  82        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
  83        outside the window, or if the window pointer is null.
  84
  85
  86 </PRE>
  87 <H2>NOTES</H2><PRE>
  88        Note that <STRONG>delch</STRONG>, <STRONG>mvdelch</STRONG>, and <STRONG>mvwdelch</STRONG> may be macros.
  89
  90
  91 </PRE>
  92 <H2>PORTABILITY</H2><PRE>
  93        These functions are described in the XSI Curses  standard,
  94        Issue  4.   The standard specifies that they return <STRONG>ERR</STRONG> on
  95        failure, but specifies no error conditions.
  96
  97
  98 </PRE>
  99 <H2>SEE ALSO</H2><PRE>
 100        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
 101
 102
 103
 104                                                          <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
 105 </PRE>
 106 <HR>
 107 <ADDRESS>
 108 Man(1) output converted with
 109 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 110 </ADDRESS>
 111 </BODY>
 112 </HTML>