X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wchstr.3x.html;h=19205551781af44bf8bbe184512aec44f074e3ea;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hp=4347004fffe051b4e36388fada0272804591e2a0;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html index 4347004f..19205551 100644 --- a/doc/html/man/curs_in_wchstr.3x.html +++ b/doc/html/man/curs_in_wchstr.3x.html @@ -1,7 +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_wch- - str, mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an - array of complex characters and renditions from a curses - window +
+ 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, starting 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_wchn- - str fill the array with at most n cchar_t elements. +
+ 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. --
- Note that all routines except win_wchnstr may be macros. - Reading a line that overflows the array pointed to by wch- - str with in_wchstr, mvin_wchstr, mvwin_wchstr or win_wch- - str causes undefined results. Therefore, the use of - in_wchnstr, mvin_wchnstr, mvwin_wchnstr, or win_wchnstr is - recommended. +
+ 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. --
- Upon successful completion, these functions return OK. - Otherwise, they return ERR. +
+ Upon successful completion, these functions return OK. Otherwise, they + return ERR. --
- The XSI Curses defines no error conditions. This imple- - mentation checks for null pointers, returning ERR in that - case. + 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 + the window pointer is null. --
- Functions: curses(3x), curs_in_wch(3x) curs_instr(3x), - curs_inwstr(3x) +
+ The XSI Curses defines no error conditions. This implementation checks + for null pointers, returning ERR in that case. + + +
+ Functions: curses(3X), curs_in_wch(3X), curs_instr(3X), curs_inwstr(3X) + curs_inchstr(3X) - curs_in_wchstr(3x) + curs_in_wchstr(3X)-