X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wch.3x.html;h=353bf908c820d99f21ec9583b7b3914dc684af56;hp=fd531b921b9e2990183c4d567d49512109f09831;hb=HEAD;hpb=d97989d1e0db7282c723cabb44b991b951790006 diff --git a/doc/html/man/curs_in_wch.3x.html b/doc/html/man/curs_in_wch.3x.html index fd531b92..f0acbd88 100644 --- a/doc/html/man/curs_in_wch.3x.html +++ b/doc/html/man/curs_in_wch.3x.html @@ -1,6 +1,7 @@ - -curs_in_wch 3x +curs_in_wch 3x 2024-04-20 ncurses 6.4 Library calls - + -

curs_in_wch 3x

curs_in_wch 3x 2024-04-20 ncurses 6.4 Library calls

-curs_in_wch(3x)                                                curs_in_wch(3x)
+curs_in_wch(3x)                  Library calls                 curs_in_wch(3x)

NAME

-       in_wch,  mvin_wch, mvwin_wch, win_wch - extract a complex character and
-       rendition from a window
+       in_wch,  mvin_wch,  mvwin_wch, win_wch - get a curses complex character
+       from a window

SYNOPSIS

        #include <curses.h>
 
-       int in_wch(cchar_t *wcval);
-       int mvin_wch(int y, int x, cchar_t *wcval);
-       int mvwin_wch(WINDOW *win, int y, int x, cchar_t *wcval);
-       int win_wch(WINDOW *win, cchar_t *wcval);
+       int in_wch(cchar_t *wch);
+       int win_wch(WINDOW *win, cchar_t *wch);
+
+       int mvin_wch(int y, int x, cchar_t *wch);
+       int mvwin_wch(WINDOW *win, int y, int x, cchar_t *wch);

DESCRIPTION

        These functions extract the complex character and  rendition  from  the
        current position in the named window into the cchar_t object referenced
-       by wcval.
+       by wch.

RETURN VALUE

-       No errors are defined in the XSI Curses standard.  This  implementation
-       checks  for null pointers, returns ERR in that case.  Also, the mv rou-
-       tines check for error moving the cursor, returning ERR  in  that  case.
-       Otherwise they return OK.
+       No errors are defined in X/Open Curses.  This implementation checks for
+       null  pointers,  returns ERR in that case.  Also, the mv routines check
+       for error moving the cursor, returning ERR  in  that  case.   Otherwise
+       they return OK.
 
-       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  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -81,15 +82,18 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       These functions are described in X/Open Curses, Issue 4.