Manual Reference Pages - GET_WCH (3)
unget_wch - get (or push back) a wide character from curses terminal keyboard
int get_wch(wint_t *wch);
int wget_wch(WINDOW *win, wint_t *wch);
int mvget_wch(int y, int x, wint_t *wch);
int mvwget_wch(WINDOW *win, int y, int x, wint_t *wch);
int unget_wch(const wchar_t wch);
functions read a character
from the terminal associated with the current or specified window.
In no-delay mode,
if no input is waiting, the value ERR is returned.
In delay mode,
the program waits until the system passes text through to the program.
Depending on the setting of cbreak,
this is after one character (cbreak mode),
or after the first newline (nocbreak mode).
In half-delay mode,
the program waits until the user types a character or the specified
timeout interval has elapsed.
Unless noecho has been set,
these routines echo the character into the designated window.
If the window is not a pad and has been moved or modified since the
last call to wrefresh,
wrefresh will be called before another character is read.
If keypad is enabled,
these functions respond to
the pressing of a function key by setting the object pointed to by
to the corresponding
If a character (such as escape) that could be the
beginning of a function key is received, curses sets a timer.
If the remainder
of the sequence does arrive within the designated time, curses passes through
the character; otherwise, curses returns the function key value.
reason, many terminals experience a delay between the time a user presses
the escape key and the time the escape is returned to the program.
function pushes the wide character
back onto the head of the input queue, so the wide character
is returned by the next call to
The pushback of
one character is guaranteed.
If the program calls
too many times without an intervening call to
the operation may fail.
The header file
includes the header file
Applications should not define the escape key by itself as a single-character
mvwget_wch, applications should
at the same time.
Depending on the state of the tty driver when each character
is typed, the program may produce undesirable results.
All functions except wget_wch and unget_wch
may be macros.
report the pressing of a function key, they return
When they successfully report a wide character, they return
Otherwise, they return
Upon successful completion,
Otherwise, the function returns
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.