X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inwstr.3x.html;h=3b8608aa47d4430040367c46cef822b9ce717003;hp=297e06ba13bb085ce1ed130bc36b78ffbc98d3ee;hb=b5be26931d6488adcb1ff8bc07df9de378ce0d27;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index 297e06ba..3b8608aa 100644 --- a/doc/html/man/curs_inwstr.3x.html +++ b/doc/html/man/curs_inwstr.3x.html @@ -1,7 +1,6 @@ - +
-- +curs_inwstr(3x) curs_inwstr(3x) --
- inwstr, innwstr, winwstr, winnwstr, mvinwstr, mvinnwstr, - mvwinwstr, mvwinnwstr - get a string of wchar_t characters - from a curses window - - --
- #include <curses.h> - - int inwstr(wchar_t *str); - int innwstr(wchar_t *str, int n); - int winwstr(WINDOW *win, wchar_t *str); - int winnwstr(WINDOW *win, wchar_t *str, int n); - int mvinwstr(int y, int x, wchar_t *str); - int mvinnwstr(int y, int x, wchar_t *str, int n); - int mvwinwstr(WINDOW *win, int y, int x, wchar_t *str); - int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *str, int n); --
- These routines return a string of wchar_t characters in - wstr, extracted starting at the current cursor position in - the named window. Attributes are stripped from the char- - acters. The four functions with n as the last argument - return a leading substring at most n bytes long (exclusive - of the trailing NUL). Transfer stops at the end of the - current line, or when n bytes have been stored at the - location referenced by wstr. - - If the size n is not large enough to store a complete - character, an error is generated. +
+ inwstr, innwstr, winwstr, winnwstr, mvinwstr, mvinnwstr, mvwinwstr, + mvwinnwstr - get a string of wchar_t characters from a curses window --
- Note that all routines except winnwstr may be macros. +
+ #include <curses.h> --
- All routines return ERR upon failure. Upon successful com- - pletion, the *inwstr routines return OK, and the *innwstr - routines return the number of characters read into the - string. + int inwstr(wchar_t *wstr); + int innwstr(wchar_t *wstr, int n); + int winwstr(WINDOW *win, wchar_t *wstr); + int winnwstr(WINDOW *win, wchar_t *wstr, int n); + int mvinwstr(int y, int x, wchar_t *wstr); + int mvinnwstr(int y, int x, wchar_t *wstr, int n); + int mvwinwstr(WINDOW *win, int y, int x, wchar_t *wstr); + int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n); --
- Functions: curses(3x), curs_instr(3x), curs_in_wchstr(3x) +
+ These routines return a string of wchar_t wide characters in wstr, + extracted starting at the current cursor position in the named window. + The four functions with n as the last argument return a leading sub- + string at most n characters long (exclusive of the trailing NUL). + Transfer stops at the end of the current line, or when n characters + have been stored at the location referenced by wstr. + If the size n is not large enough to store a complete complex charac- + ter, an error is generated. +
+ All routines except winnwstr may be macros. + Each cell in the window holds a complex character (i.e., base- and com- + bining-characters) together with attributes and color. These functions + store only the wide characters, ignoring attributes and color. Use + in_wchstr to return the complex characters from a window. +
+ All routines return ERR upon failure. Upon successful completion, the + *inwstr routines return OK, and the *innwstr routines return the number + of characters read into the string. + 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. +
+ curses(3x), curs_instr(3x), curs_in_wchstr(3x) + curs_inwstr(3x)-