usr/src/man/man3xcurses/erasechar.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ERASECHAR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 erasechar, erasewchar, killchar, killwchar \- return current ERASE or KILL
   9 characters
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBchar\fR \fBerasechar\fR(\fBvoid\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBerasewchar\fR(\fBwchar_t *\fR\fIch\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBchar\fR \fBkillchar\fR(\fBvoid\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBkillwchar\fR(\fBwchar_t *\fR\fIch\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBerasechar()\fR function returns the current ERASE character  from the
  42 tty driver.  This character is used to delete the previous character during
  43 keyboard input.  The returned value can be used when including deletion
  44 capability in  interactive programs.
  45 .sp
  46 .LP
  47 The \fBkillchar()\fR function is similar to \fBerasechar()\fR. It returns the
  48 current KILL character.
  49 .sp
  50 .LP
  51 The \fBerasewchar()\fR and \fBkillwchar()\fR functions are similar to
  52 \fBerasechar()\fR and \fBkillchar()\fR respectively, but store the  ERASE or
  53 KILL character in the object pointed to by \fIch\fR.
  54 .SH PARAMETERS
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIch\fR\fR
  59 .ad
  60 .RS 6n
  61 Is a pointer to a location where a character may be stored.
  62 .RE
  63
  64 .SH RETURN VALUES
  65 .sp
  66 .LP
  67 For \fBerasechar()\fR and \fBkillchar()\fR, the terminal's current  ERASE or
  68 KILL character is returned.
  69 .sp
  70 .LP
  71 On success, the \fBerasewchar()\fR and \fBkillwchar()\fR functions return
  72 \fBOK\fR. Otherwise, they return \fBERR\fR.
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Standard
  87 _
  88 MT-Level        Unsafe
  89 .TE
  90
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBgetch\fR(3XCURSES), \fBgetstr\fR(3XCURSES), \fBget_wch\fR(3XCURSES),
  95 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)