Manualshelf

get_wch.3x (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages
12
g
get_wch(3X) get_wch(3X)
(ENHANCED CURSES)
NAME
get_wch, mvget_wch, mvwget_wch, wget_wch — get a wide character from a terminal
SYNOPSIS
#include <curses.h>
int get_wch(wint_t *ch);
int mvget_wch(int y, int x, wint_t *ch);
int mvwget_wch(WINDOW *win, int y, int x, wint_t *ch);
int wget_wch(WINDOW *win, wint_t *ch);
DESCRIPTION
These functions read a character from the terminal associated with the current or specified window. If
keypad() is enabled, these functions respond to the pressing of a function key by setting the object
pointed to by ch to the corresponding
KEY_ value defined in
<curses.h> and returning
KEY_CODE_YES.
Processing of terminal input is subject to the general rules described in Input Processing in
curses_intro (3X).
If echoing is enabled, then the character is echoed as though it were provided as an input argument to
ins_wch(), except for the following characters:
<backspace>, <left-arrow> and
the current erase character:
The input is interpreted as specified in
special-
chars and then the character at the resulting cur-
sor position is deleted as though delch() were
called, except that if the cursor was originally in
the first column of the line, then the user is alerted
as though beep() were called.
The user is alerted as though beep() were called.
Information concerning the function keys is not
returned to the caller.Function keys
If the current or specified window is not a pad, and it has been moved or modified since the last refresh
operation, then it will be refreshed before another character is read.
RETURN VALUE
When these functions successfully report the pressing of a function key, they return
KEY_CODE_YES.
When they successfully report a wide character, they return OK. Otherwise, they return ERR.
ERRORS
No errors are defined.
APPLICATION USAGE
Applications should not define the escape key by itself as a single-character function.
When using these functions,
nocbreak() mode and echo() mode 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.
SEE ALSO
beep(3X), cbreak(3X), ins_wch(3X), keypad(3X), move(3X), curses_intro(3X), see Input Processing,
<curses.h>, <wchar.h> (in the X/Open System Interfaces and Headers, Issue 4, Version 2 specification).
CHANGE HISTORY
First released in X/Open Curses, Issue 4.
HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (2 pages)