Проект OpenNet: MAN getch (3) Библиотечные вызовы (FreeBSD и Linux)

Интерактивная система просмотра системных руководств (man-ов)

getch (3)

>> getch (3) ( Solaris man: Библиотечные вызовы )

getch (3) ( FreeBSD man: Библиотечные вызовы )

NAME

getch, wgetch, mvgetch, mvwgetch - get a single-byte character from the terminal

SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int getch(void);

int wgetch(WINDOW *win);

int mvgetch(int y, int x);

int mvwgetch(WINDOW *win, int y, int x);

PARAMETERS

win

: Is a pointer to the window associated with the terminal from which the character is to be read.

: Is the y (row) coordinate for the position of the character to be read.

: Is the x (column) coordinate for the position of the character to be read.

DESCRIPTION

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 keypad(3XCURSES) is enabled, these functions respond to the pressing of a function key by returning the corresponding KEY_ value defined in <curses.h>

Processing of terminal input is subject to the general rules described on the keypad(3XCURSES) manual page.

If echoing is enabled, then the character is echoed as though it were provided as an input argument to addch(3XCURSES), except for the following characters:

<backspace>

: 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 delch(3XCURSES) were called, except that if the cursor was originally in the first column of the line, the user is alerted as though beep(3XCURSES) were called.

Function keys

: The user is alerted as though beep() were called. Information concerning the function keys is not returned to the caller.

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.

Constant Values for Function Keys

The following is a list of tokens for function keys that are returned by the getch() set of functions if keypad handling is enabled (some terminals may not support all tokens).

Constant Description

KEY_BREAK Break key

KEY_DOWN

KEY_UP

KEY_LEFT

KEY_RIGHT

KEY_HOME

KEY_BACKSPACE

KEY_F0

KEY_F(n)

KEY_DL

KEY_IL

KEY_DC

KEY_IC

KEY_EIC

KEY_CLEAR

KEY_EOS

KEY_EOL

KEY_SF

KEY_SR

KEY_NPAGE

KEY_PPAGE

KEY_STAB

KEY_CTAB

KEY_CATAB

KEY_ENTER

KEY_SRESET

KEY_RESET

KEY_PRINT

KEY_LL

KEY_A1

KEY_A3

KEY_B2

KEY_C1

KEY_C3

keypad

KEY_BTAB

KEY_BEG

KEY_CANCEL

KEY_CLOSE

KEY_COMMAND

KEY_COPY

KEY_CREATE

KEY_END

KEY_EXIT

KEY_FIND

KEY_HELP

KEY_MARK

KEY_MESSAGE

KEY_MOVE

KEY_NEXT

KEY_OPEN

KEY_OPTIONS

KEY_PREVIOUS

KEY_REDO

KEY_REFERENCE

KEY_REFRESH

KEY_REPLACE

KEY_RESTART

KEY_RESUME

KEY_SAVE

KEY_SBEG

KEY_SCANCEL

KEY_SCOMMAND

KEY_SCOPY

KEY_SCREATE

KEY_SDC

KEY_SDL

KEY_SELECT

KEY_SEND

KEY_SEOL

KEY_SEXIT

KEY_SFIND

KEY_SHELP

KEY_SHOME

KEY_SIC

KEY_SLEFT

KEY_SMESSAGES

KEY_SMOVE

KEY_SNEXT

KEY_SOPTIONS

KEY_SPREVIOUS

KEY_SPRINT

KEY_SREDO

KEY_SREPLACE

KEY_SRIGHT

KEY_SRSUME

KEY_SSAVE

KEY_SSUSPEND

KEY_SUNDO

KEY_SUSPEND

KEY_UNDO

RETURN VALUES

Upon successful completion, these functions return the single-byte character, KEY_ value, or ERR. When in the nodelay mode and no data is available, ERR is returned.

ERRORS

No errors are defined.

USAGE

Applications should not define the escape key by itself as a single-character function.

When using these functions, nocbreak mode (cbreak(3XCURSES)) and echo mode (echo(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.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Standard

MT-Level

Index

Constant Values for Function Keys

Хоcтинг: