X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wch.3x.html;h=ca8d2e8c02e288c9ee9cefedf2f0702000ba4531;hp=ddd3f4b1f000e7417dd8679237388b271729b95a;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_get_wch.3x.html b/doc/html/man/curs_get_wch.3x.html index ddd3f4b1..ca8d2e8c 100644 --- a/doc/html/man/curs_get_wch.3x.html +++ b/doc/html/man/curs_get_wch.3x.html @@ -1,7 +1,7 @@ - +
@@ -40,6 +40,10 @@+curs_get_wch(3x) curs_get_wch(3x) + + +
@@ -52,10 +56,10 @@SYNOPSIS
#include <curses.h> - int get_wch(win_t *wch); - int wget_wch(WINDOW *win, win_t *wch); - int mvget_wch(int y, int x, win_t *wch); - int mvwget_wch(WINDOW *win, int y, int x, win_t *wch); + 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); @@ -100,7 +104,6 @@ operation may fail. -NOTES
The header file <curses.h> automatically includes the @@ -119,47 +122,29 @@-RETURN VALUES
- When get_wch, wget_wch, mvget_wch, and mvwget_wch func- - tions successfully report the pressing of a function key, +RETURN VALUE
+ When get_wch, wget_wch, mvget_wch, and mvwget_wch func- + tions 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 + wide character, they return OK. Otherwise, they return ERR. - Upon successful completion, unget_wch returns OK. Other- + Upon successful completion, unget_wch returns OK. Other- wise, the function returns ERR. + Functions with a "mv" prefix first perform a cursor move- + ment using wmove, and return an error if the position is + outside the window, or if the window pointer is null. +SEE ALSO
- curses(3x), curs_getch(3x), curs_ins_wch(3x), + curses(3x), curs_getch(3x), curs_ins_wch(3x), curs_inopts(3x), curs_move(3x), curs_refresh(3x) - - - - - - - - - - - - - - - - - - - - - - - + curs_get_wch(3x)