X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wchstr.3x.html;h=74a3b4bfafbb6201557e45fb110f4edb56fa6691;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=19205551781af44bf8bbe184512aec44f074e3ea;hpb=9f479192e3ca3413d235c66bf058f8cc63764898;p=ncurses.git diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html index 19205551..74a3b4bf 100644 --- a/doc/html/man/curs_in_wchstr.3x.html +++ b/doc/html/man/curs_in_wchstr.3x.html @@ -1,6 +1,6 @@ -curs_in_wchstr 3X +curs_in_wchstr 3x 2024-05-25 ncurses 6.5 Library calls - + -

curs_in_wchstr 3X

curs_in_wchstr 3x 2024-05-25 ncurses 6.5 Library calls

-curs_in_wchstr(3X)                                          curs_in_wchstr(3X)
+curs_in_wchstr(3x)               Library calls              curs_in_wchstr(3x)

NAME

-       in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr,
-       mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get an array of complex
-       characters and renditions from a curses window
+       in_wchstr,    in_wchnstr,    win_wchstr,    win_wchnstr,   mvin_wchstr,
+       mvin_wchnstr,  mvwin_wchstr,  mvwin_wchnstr  -  get  a  curses  complex
+       character string from a window

SYNOPSIS

-       #include <curses.h>
+       #include <curses.h>
 
-       int in_wchstr(cchar_t *wchstr);
-       int in_wchnstr(cchar_t *wchstr, int n);
-       int win_wchstr(WINDOW *win, cchar_t *wchstr);
-       int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
+       int in_wchstr(cchar_t *wchstr);
+       int win_wchstr(WINDOW *win, cchar_t *wchstr);
+       int mvin_wchstr(int y, int x, cchar_t *wchstr);
+       int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
 
-       int mvin_wchstr(int y, int x, cchar_t *wchstr);
-       int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
-       int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
-       int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);
+       int in_wchnstr(cchar_t *wchstr, int n);
+       int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
+       int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
+       int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);

DESCRIPTION

-       These functions return an array of complex characters in wchstr, start-
-       ing at the current cursor position in  the  named  window.   Attributes
-       (rendition) are stored with the characters.
+       These  functions  return  an  array  of  complex  characters in wchstr,
+       starting  at  the  current  cursor  position  in  the   named   window.
+       Attributes (rendition) are stored with the characters.
 
-       The  in_wchnstr,  mvin_wchnstr,  mvwin_wchnstr and win_wchnstr fill the
-       array with at most n cchar_t elements.
+       The  four  functions  with  n  as  the  last  argument return a leading
+       substring at most n characters long (exclusive of the  trailing  zeroed
+       cchar_t.   Transfer  stops  at  the  end of the current line, or when n
+       characters have been stored at the location referenced by wchstr.
 
+       Constants defined in <curses.h> can be used with the  &  (logical  AND)
+       operator  to  extract  the  character  or  the attribute alone from any
+       position in the wchstr [see getcchar(3x)].
 
-

NOTES

-       Note that all routines except win_wchnstr may be macros.
 
-       Reading a line that overflows the  array  pointed  to  by  wchstr  with
-       in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined re-
-       sults.  Therefore, the use of in_wchnstr, mvin_wchnstr,  mvwin_wchnstr,
-       or win_wchnstr is recommended.
+

RETURN VALUE

+       Upon successful completion, these functions return OK.  Otherwise, they
+       return ERR.
+
+       X/Open Curses defines no error conditions.  This implementation returns
+       ERR
 
+       o   if the win parameter is null or
 
-

RETURN VALUE

-       Upon successful completion, these functions return OK.  Otherwise, they
-       return ERR.
+       o   if the wchstr parameter is null.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
 
-       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.
+
+

NOTES

+       All routines except win_wchnstr may be macros.
+
+       Reading  a  line  that  overflows  the  array pointed to by wchstr with
+       in_wchstr, mvin_wchstr, mvwin_wchstr  or  win_wchstr  causes  undefined
+       results.     Therefore,    the   use   of   in_wchnstr,   mvin_wchnstr,
+       mvwin_wchnstr, or win_wchnstr is recommended.

PORTABILITY

-       The XSI Curses defines no error conditions.  This implementation checks
-       for null pointers, returning ERR in that case.
+       X/Open Curses defines no error conditions.  This implementation  checks
+       for null pointers, returning ERR in that case.