X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wchstr.3x.html;h=f1b048f51307dfaf660dcf85ee9ec598110918b7;hb=HEAD;hp=b5a40bdff2300cc15ef2bf87edb3b7411a455485;hpb=cb4427a16794d98049b4d790b810d62217501f9f;p=ncurses.git diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html index b5a40bdf..74a3b4bf 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) Library calls 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 - characters and renditions from a curses window + in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr, + mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get a curses complex + character string from a window
#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); - -
- 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. + int in_wchnstr(cchar_t *wchstr, int n); + int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n); + int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n); + int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n); - The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the - array with at most n cchar_t elements. +
+ 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. -
- Note that all routines except win_wchnstr may be macros. + The four functions with n as the last argument return a leading + substring at most n characters long (exclusive of the trailing zeroed + cchar_t. Transfer stops at the end of the current line, or when n + characters have been stored at the location referenced by wchstr. - 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. + Constants defined in <curses.h> can be used with the & (logical AND) + operator to extract the character or the attribute alone from any + position in the wchstr [see getcchar(3x)].
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 - the window pointer is null. + X/Open Curses defines no error conditions. This implementation returns + ERR + + o if the win parameter is null or + + o if the wchstr parameter is null. + + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries. + + +
+ 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 + results. Therefore, the use of in_wchnstr, mvin_wchnstr, + mvwin_wchnstr, or win_wchnstr is recommended.
- The XSI Curses defines no error conditions. This implementation checks + X/Open 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_inchstr(3x) describes comparable functions of the ncurses library + in its non-wide-character configuration. + + curses(3x), curs_inwstr(3x), curs_in_wch(3x) - curs_in_wchstr(3x) +ncurses 6.5 2024-05-25 curs_in_wchstr(3x)