curs_inwstr(3x) 맨 페이지 - 윈디하나의 솔라나라

개요

섹션
맨 페이지 이름
검색(S)

curs_inwstr(3x)

curs_inwstr(3x)                  Library calls                 curs_inwstr(3x)

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

SYNOPSIS
       #include <ncursesw/curses.h>

       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
       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  wide  charac‐
       ters from win.  A negative n implies no limit; winnwstr then works like
       winwstr.  ncurses(3X) describes the variants of these functions.

RETURN VALUE
       On successful operation, these functions return the count of wide char‐
       acters  copied  from  win  to  wstr,  or  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

       •   the curses screen has not been initialized,

       •   (for functions taking a WINDOW pointer  argument)  win  is  a  null
           pointer, or

       •   wstr is a null pointer.

       Functions  prefixed with “mv” first perform cursor movement and fail if
       the position (y, x) is outside the window boundaries.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:

       box; cbp-1 | cbp-1 l | l .  ATTRIBUTE TYPE ATTRIBUTE VALUE = Availabil‐
       ity   library/ncurses = Stability Uncommitted

NOTES
       All of these functions except winnwstr may be implemented as macros.

       Reading a line that overflows the array pointed to by wstr with inwstr,
       winwstr, mvinwstr, or  mvwinwstr  causes  undefined  results.   Use  of
       innwstr, winnwstr, mvinnwstr, and mvwinnwstr is recommended instead.

       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at:
       https://github.com/oracle/solaris-userland

       The original community source was downloaded from:
       https://invisible-mirror.net/archives/ncurses/cur‐
       rent/ncurses-6.5-20250614.tgz

       Further information about this software can be found on the open source
       community website at https://invisible-island.net/ncurses/.

EXTENSIONS
       innwstr, winnwstr, mvinnwstr, and mvwinnwstr's acceptance of negative n
       values 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 can‐
       not use their return values to detect truncation  of  a  wide-character
       string  copied  from  more than one character cell in win.  ncurses re‐
       ports any truncation with ERR.

       X/Open Curses specifies inwstr, winwstr, mvinwstr, and mvwinwstr as re‐
       turning 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.

HISTORY
       The System V Interface Definition, Version 4 (1995), specified  winwstr
       and  winnwstr  (and the usual variants).  These were later additions to
       SVr4.x, not appearing in the first SVr4  (1989).   Their  synopses  de‐
       scribed each function as taking an argument of type pointer-to-char in‐
       stead  of pointer-to-wchar_t, despite describing them as “returning the
       string of wchar_t in str”.  Presumably this was an error  in  the  Sys‐
       tem V Interface Definition.

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                       2025-03-01                   curs_inwstr(3x)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3