X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inwstr.3x.html;h=3b8608aa47d4430040367c46cef822b9ce717003;hp=2b9b52912c4e010ede3e7700ffc1e6b1868dc5d5;hb=b5be26931d6488adcb1ff8bc07df9de378ce0d27;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index 2b9b5291..3b8608aa 100644 --- a/doc/html/man/curs_inwstr.3x.html +++ b/doc/html/man/curs_inwstr.3x.html @@ -1,6 +1,6 @@ @@ -53,39 +53,44 @@

SYNOPSIS

        #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);
+       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);

DESCRIPTION

-       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.
+       These routines return a string of  wchar_t  wide  characters  in  wstr,
+       extracted starting at the current cursor position in the named window.
 
-       If the size n is not large enough to store  a  complete  character,  an
-       error is generated.
+       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.

NOTES

-       Note that all routines except winnwstr may be macros.
+       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.

RETURN VALUE

-       All  routines  return ERR upon failure. Upon successful completion, the
+       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
+       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.