X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wchstr.3x.html;h=19205551781af44bf8bbe184512aec44f074e3ea;hp=b5a40bdff2300cc15ef2bf87edb3b7411a455485;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=cb4427a16794d98049b4d790b810d62217501f9f diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html index b5a40bdf..19205551 100644 --- a/doc/html/man/curs_in_wchstr.3x.html +++ b/doc/html/man/curs_in_wchstr.3x.html @@ -1,6 +1,7 @@ -
--curs_in_wchstr(3x) curs_in_wchstr(3x) +curs_in_wchstr(3X) curs_in_wchstr(3X)
- in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr, - mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an array of complex + in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr, + mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an array of complex characters and renditions from a curses window
- #include <curses.h> + #include <curses.h> - int in_wchstr(cchar_t *wchstr); - int in_wchnstr(cchar_t *wchstr, int n); - int win_wchstr(WINDOW *win, cchar_t *wchstr); - int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n); - int mvin_wchstr(int y, int x, cchar_t *wchstr); - int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n); - int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr); - int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n); + int in_wchstr(cchar_t *wchstr); + int in_wchnstr(cchar_t *wchstr, int n); + int win_wchstr(WINDOW *win, cchar_t *wchstr); + int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n); + + int mvin_wchstr(int y, int x, cchar_t *wchstr); + int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n); + int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr); + int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);
- These functions return an array of complex characters in wchstr, start- + These functions return an array of complex characters in wchstr, start- ing at the current cursor position in the named window. Attributes (rendition) are stored with the characters. - The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the - array with at most n cchar_t elements. + The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the + array with at most n cchar_t elements.
- Note that all routines except win_wchnstr may be macros. + Note that all routines except win_wchnstr may be macros. - Reading a line that overflows the array pointed to by wchstr with - in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined re- - sults. Therefore, the use of in_wchnstr, mvin_wchnstr, mvwin_wchnstr, - or win_wchnstr is recommended. + Reading a line that overflows the array pointed to by wchstr with + in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined re- + sults. Therefore, the use of in_wchnstr, mvin_wchnstr, mvwin_wchnstr, + or win_wchnstr is recommended.
- Upon successful completion, these functions return OK. Otherwise, they - return ERR. + Upon successful completion, these functions return OK. Otherwise, they + return ERR. Functions with a "mv" prefix first perform a cursor movement using - wmove, and return an error if the position is outside the window, or if + wmove, and return an error if the position is outside the window, or if the window pointer is null.
The XSI Curses defines no error conditions. This implementation checks - for null pointers, returning ERR in that case. + for null pointers, returning ERR in that case.
- Functions: curses(3x), curs_in_wch(3x), curs_instr(3x), curs_inwstr(3x) - curs_inchstr(3x) + Functions: curses(3X), curs_in_wch(3X), curs_instr(3X), curs_inwstr(3X) + curs_inchstr(3X) - curs_in_wchstr(3x) + curs_in_wchstr(3X)