X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=inline;f=doc%2Fhtml%2Fman%2Fcurs_in_wch.3x.html;h=353bf908c820d99f21ec9583b7b3914dc684af56;hb=HEAD;hp=9698ca44e21c8900325ff150bd67edfce5449a6f;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40;p=ncurses.git diff --git a/doc/html/man/curs_in_wch.3x.html b/doc/html/man/curs_in_wch.3x.html index 9698ca44..a04f410f 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-05-18 ncurses 6.5 Library calls + + -

curs_in_wch 3x

curs_in_wch 3x 2024-05-18 ncurses 6.5 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.
+       win_wch copies the curses complex character at the cursor  position  in
+       win  into  wch.   Use  getcchar(3x)  to  extract  its  character  code,
+       attributes, and  color  pair  identifier.   ncurses(3x)  describes  the
+       variants of this function.

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
+       These functions return OK on success and ERR on failure.
+
+       In ncurses, win_wch returns ERR if win is NULL.
 
-       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

-       Note that all of these routines may be macros.
+       in_wch, mvin_wch, and mvwin_wch may be implemented as macros.
+
+       Unlike winch(3x), win_wch and its  variants  store  the  value  of  the
+       retrieved  character  in  an  additional  wch  parameter instead of the
+       return value.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
+       error conditions for them.