'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.\" 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.
.\" 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.
.\" 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]
.TH getch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
getch, wgetch, mvgetch, mvwgetch \- get a single-byte character from the
terminal
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
 
#include <curses.h>

\fBint\fR \fBgetch\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBint\fR \fBwgetch\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.LP
.nf
\fBint\fR \fBmvgetch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.LP
.nf
\fBint\fR \fBmvwgetch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to the window associated with the terminal from which the
character is to be read.
.RE

.sp
.ne 2
.mk
.na
\fB\fIy\fR\fR
.ad
.RS 7n
.rt  
Is the y (row) coordinate for the position of the character to be read.
.RE

.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 7n
.rt  
Is the x (column) coordinate for the position of the character to be read.
.RE

.SH DESCRIPTION
.sp
.LP
These functions read a single-byte character from the terminal associated with
the current or specified window. The results are unspecified if the input is
not a single-byte character. If \fBkeypad\fR(3XCURSES) is enabled, these
functions respond to the pressing of a function key by returning the
corresponding \fBKEY_\fR value defined in <\fBcurses.h\fR>
.sp
.LP
Processing of terminal input is subject to the general rules described on the
\fBkeypad\fR(3XCURSES) manual page.
.sp
.LP
If echoing is enabled, then the character is echoed as though it were provided
as an input argument to \fBaddch\fR(3XCURSES), except for the following
characters:
.sp
.ne 2
.mk
.na
\fB<backspace>\fR
.ad
.RS 17n
.rt  
The input is interpreted as follows: unless the cursor already was in column 0,
<backspace> moves the cursor one column toward the start of the current line
and any characters after the <backspace> are added or inserted starting there.
The character at the resulting cursor position it then deleted as though
\fBdelch\fR(3XCURSES) were called, except that if the cursor was originally in
the first column of the line, the user is alerted as though
\fBbeep\fR(3XCURSES) were called.
.RE

.sp
.ne 2
.mk
.na
\fBFunction keys\fR
.ad
.RS 17n
.rt  
The user is alerted  as though \fBbeep()\fR were called. Information concerning
the function keys is not returned to the caller.
.RE

.sp
.LP
If the current or specified window is not a pad, and it has been moved modified
since the last refresh operation, then it will be refreshed before another
character is read.
.SS "Constant Values for Function Keys"
.sp
.LP
The following is a list of tokens for function keys that are returned by  the
\fBgetch()\fR set of functions if keypad handling is enabled (some  terminals
may not support all tokens).
.sp

.sp
.TS
tab() box;
cw(1.65i) cw(3.85i) 
lw(1.65i) lw(3.85i) 
.
\fBConstant\fR\fBDescription\fR
_
KEY_BREAKBreak key
KEY_DOWNThe down arrow key
KEY_UPThe up arrow key
KEY_LEFTThe left arrow key
KEY_RIGHTThe right arrow key
KEY_HOMEHome key
KEY_BACKSPACEBackspace
KEY_F0T{
Function keys.  Space for 64 keys is reserved.
T}
KEY_F(\fIn\fR)For  0 <= \fIn\fR <= 63
KEY_DLDelete line
KEY_ILInsert line
KEY_DCDelete character
KEY_ICInsert char or enter insert mode
KEY_EICExit insert char mode
KEY_CLEARClear screen
KEY_EOSClear to end of screen
KEY_EOLClear to end of line
KEY_SFScroll 1 line forward
 KEY_SRScroll 1 line backwards
KEY_NPAGENext page
KEY_PPAGEPrevious page
KEY_STABSet tab
KEY_CTABClear tab
KEY_CATABClear all tabs
KEY_ENTEREnter or send
KEY_SRESETSoft (partial) reset
KEY_RESETReset or hard reset
KEY_PRINTPrint or copy
KEY_LLHome down or bottom (lower left)
KEY_A1Upper left of keypad
KEY_A3Upper right of keypad
KEY_B2Center of keypad
KEY_C1Lower left of keypad
KEY_C3Lower right of keypad
KEY_BTABBack tab
KEY_BEGBeginning key
KEY_CANCELCancel key
KEY_CLOSEClose key
KEY_COMMANDCmd (command) key
KEY_COPYCopy key
KEY_CREATECreate key
KEY_ENDEnd key
KEY_EXITExit key
KEY_FINDFind key
KEY_HELPHelp key
KEY_MARKMark key
KEY_MESSAGEMessage key
KEY_MOVEMove key
KEY_NEXTNext object key
KEY_OPENOpen key
KEY_OPTIONSOptions key
KEY_PREVIOUSPrevious object key
KEY_REDORedo key
KEY_REFERENCEReference key
KEY_REFRESHRefresh key
KEY_REPLACEReplace key
KEY_RESTARTRestart key
KEY_RESUMEResume key
KEY_SAVESave key
KEY_SBEGShifted beginning key
KEY_SCANCELShifted cancel key
KEY_SCOMMANDShifted command key
KEY_SCOPYShifted copy key
KEY_SCREATEShifted create key
KEY_SDCShifted delete char key
KEY_SDLShifted delete line key
KEY_SELECTSelect key
KEY_SENDShifted end key
KEY_SEOLShifted clear line key
KEY_SEXITShifted exit key
KEY_SFINDShifted find key
KEY_SHELPShifted help key
KEY_SHOMEShifted home key
KEY_SICShifted input key
KEY_SLEFT Shifted left arrow key
KEY_SMESSAGESShifted messages key
KEY_SMOVEShifted move key
KEY_SNEXTShifted next key
KEY_SOPTIONSShifted options key
KEY_SPREVIOUSShifted previous key
KEY_SPRINTShifted print key
KEY_SREDOShifted redo key
KEY_SREPLACEShifted replace key
KEY_SRIGHTShifted right arrow key
KEY_SRSUMEShifted resume key
KEY_SSAVEShifted save key
KEY_SSUSPENDShifted suspend key
KEY_SUNDOShifted undo key
KEY_SUSPENDSuspend key
KEY_UNDOUndo key
.TE

.SH RETURN VALUES
.sp
.LP
Upon successful completion, these functions return the single-byte character,
\fBKEY_\fR value, or \fBERR\fR. When in the nodelay mode and no data is
available, \fBERR\fR is returned.
.SH ERRORS
.sp
.LP
No errors are defined.
.SH  USAGE
.sp
.LP
Applications should not define the escape key by itself as a single-character
function.
.sp
.LP
When using these functions, nocbreak mode (\fBcbreak\fR(3XCURSES)) and echo
mode (\fBecho\fR(3XCURSES)) should not be used at the same time. Depending on
the state of the terminal when each character is typed, the application may
produce undesirable results.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityStandard
_
MT-LevelUnsafe
.TE

.SH SEE ALSO
.sp
.LP
\fBcbreak\fR(3XCURSES), \fBecho\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES),
\fBkeypad\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnodelay\fR(3XCURSES),
\fBnotimeout\fR(3XCURSES), \fBraw\fR(3XCURSES), \fBtimeout\fR(3XCURSES),
\fBattributes\fR(5), \fBstandards\fR(5)