X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wch.3x.html;h=7fed34ba9edd4f17b8937142670c7fa70a9a08de;hp=f0acbd8886a1afbf222011733670a56d71381f6c;hb=HEAD;hpb=00dd248b527ad47f0fc3b0776a0889da0ac926d0 diff --git a/doc/html/man/curs_in_wch.3x.html b/doc/html/man/curs_in_wch.3x.html index f0acbd88..a04f410f 100644 --- a/doc/html/man/curs_in_wch.3x.html +++ b/doc/html/man/curs_in_wch.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_in_wch.3x,v 1.31 2024/04/20 21:20:07 tom Exp @ + * @Id: curs_in_wch.3x,v 1.33 2024/05/18 20:19:38 tom Exp @ --> -curs_in_wch 3x 2024-04-20 ncurses 6.4 Library calls +curs_in_wch 3x 2024-05-18 ncurses 6.5 Library calls -

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

curs_in_wch 3x 2024-05-18 ncurses 6.5 Library calls

 curs_in_wch(3x)                  Library calls                 curs_in_wch(3x)
 
@@ -54,46 +54,50 @@

SYNOPSIS

        #include <curses.h>
 
-       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);
+       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 wch.
+       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 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.
+       These functions return OK on success and ERR on failure.
+
+       In ncurses, win_wch returns ERR if win 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 X/Open Curses, Issue 4.
+       X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
+       error conditions for them.