User Tools

Site Tools


solaris:getch.3xcurses

getch


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.

y

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

x

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).

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(7) for descriptions of the following attributes:

SEE ALSO

raw(3XCURSES), cbreak(3XCURSES), echo(3XCURSES), halfdelay(3XCURSES), keypad(3XCURSES), libcurses(3XCURSES), nodelay(3XCURSES), notimeout(3XCURSES), timeout(3XCURSES), attributes(7), standards(7)


solaris/getch.3xcurses.txt · Last modified: 2023/07/19 08:58 by A User Not Logged in