X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inwstr.3x.html;h=2b9b52912c4e010ede3e7700ffc1e6b1868dc5d5;hp=224c6d57cf8eec98ccc4521fe5851a5f3df536fd;hb=ed646e3f683083e787c6ba773364401dc9fa9d40;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index 224c6d57..2b9b5291 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) +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 +
+ 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); @@ -66,46 +63,49 @@ 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. +
+ 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 characters. 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 cur- + rent 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. + If the size n is not large enough to store a complete character, an + error is generated. --
+
Note that all routines except winnwstr may be macros. --
- 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. +
+ 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. --
- Functions: curses(3x), curs_instr(3x), curs_in_wchstr(3x) + +
+ curses(3x), curs_instr(3x), curs_in_wchstr(3x) - curs_inwstr(3x) + curs_inwstr(3x)-