X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inwstr.3x.html;h=ddd51afb2927de8f884eb467c5b2b9e631edce82;hb=HEAD;hp=297e06ba13bb085ce1ed130bc36b78ffbc98d3ee;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index 297e06ba..d5777a28 100644 --- a/doc/html/man/curs_inwstr.3x.html +++ b/doc/html/man/curs_inwstr.3x.html @@ -1,7 +1,7 @@ - - + -curs_inwstr 3 - - + + +curs_inwstr 3x 2024-06-08 ncurses 6.5 Library calls + + -

curs_inwstr 3

-
+

curs_inwstr 3x 2024-06-08 ncurses 6.5 Library calls

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

NAME

-       inwstr,  innwstr,  winwstr, winnwstr, mvinwstr, mvinnwstr,
-       mvwinwstr, mvwinnwstr - get a string of wchar_t characters
-       from a curses window
 
 
-
-

SYNOPSIS

+
+

NAME

+       inwstr,  innwstr,  winwstr,  winnwstr,  mvinwstr, mvinnwstr, mvwinwstr,
+       mvwinnwstr - get a wide-character string from a curses window
+
+
+

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 winwstr(WINDOW * win, wchar_t * wstr);
+       int mvinwstr(int y, int x, wchar_t * wstr);
+       int mvwinwstr(WINDOW * win, int y, int x, wchar_t * wstr);
 
+       int innwstr(wchar_t * wstr, int n);
+       int winnwstr(WINDOW * win, wchar_t * wstr, int n);
+       int mvinnwstr(int y, int x, wchar_t * wstr, int n);
+       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 char-
-       acters.  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
-       current  line,  or  when  n  bytes have been stored at the
-       location referenced by wstr.
 
-       If the size n is not large  enough  to  store  a  complete
-       character, an error is generated.
+

DESCRIPTION

+       winwstr extracts a wide-character string  from  a  curses  window  win,
+       starting  at the cursor and stopping at the end of the line, and stores
+       it in wstr, terminating it with a wide null character and omitting  any
+       attributes  and  color pair identifier that curses associates with each
+       character.  winnwstr does the same, but copies  at  most  n  characters
+       from  win.   An  n  of  -1  implies  no limit; winnwstr then works like
+       winwstr.  ncurses(3x) describes the variants of these functions.
 
 
-
-

NOTES

-       Note that all routines except winnwstr may be macros.
+

RETURN VALUE

+       On successful operation, these  functions  return  the  count  of  wide
+       characters  copied  from  win  to  wstr.  They return ERR upon failure.
+       innwstr, winnwstr,  mvinnwstr,  and  mvwinnwstr  return  ERR  if  n  is
+       insufficiently  large  to  store  a  complete  wide  character  string.
+       (Recall that a curses  complex  character  can  contain  multiple  wide
+       characters, some of which may be non-spacing.)
 
+       In ncurses, these functions return ERR if
 
-
-

RETURN VALUES

-       All routines return ERR upon failure. Upon successful com-
-       pletion, the *inwstr routines return OK, and the  *innwstr
-       routines  return  the  number  of characters read into the
-       string.
+       o   win is NULL or
 
+       o   wstr is NULL.
 
-
-

SEE ALSO

-       Functions: curses(3x), curs_instr(3x), curs_in_wchstr(3x)
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

+       All of these functions except winnwstr may be implemented as macros.
+
+       Reading a line that overflows the array pointed to by str with  inwstr,
+       winwstr,  mvinwstr,  or  mvwinwstr  causes  undefined  results.  Use of
+       innwstr, winnwstr, mvinnwstr, and mvwinnwstr is recommended instead.
 
 
+

EXTENSIONS

+       innwstr, winnwstr, mvinnwstr, and mvwinnwstr's treatment  of  -1  as  a
+       valid value of n is an ncurses extension.
 
 
+

PORTABILITY

+       Applications employing ncurses extensions should condition their use on
+       the visibility of the NCURSES_VERSION preprocessor macro.
 
+       X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
+       error conditions for them.
 
+       Notwithstanding  the foregoing, X/Open Curses Issues 4 and 7 both state
+       that innwstr, winnwstr, mvinnwstr, and mvwinnwstr "fail  ...  [i]f  the
+       array  is  not  large  enough  to  contain  any  complete  characters".
+       Strictly interpreted, this means  that  a  caller  of  these  functions
+       cannot use their return values to detect truncation of a wide-character
+       string copied from more  than  one  character  cell  in  win.   ncurses
+       reports any truncation with ERR.
 
+       X/Open  Curses  specifies  inwstr,  winwstr, mvinwstr, and mvwinwstr as
+       returning OK rather than a (wide) character count,  unlike  their  non-
+       wide  counterparts  instr,  winstr,  mvinstr,  and  mvwinstr.   ncurses
+       regards this inconsistency as an error in the standard.
 
 
+

SEE ALSO

+       curs_instr(3x) describes comparable functions of the ncurses library in
+       its non-wide-character configuration.
 
+       curses(3x), curs_in_wch(3x), curs_in_wchstr(3x)
 
 
 
+ncurses 6.5                       2024-06-08                   curs_inwstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +