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

개요

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

curs_instr(3x)

curs_instr(3x)                   Library calls                  curs_instr(3x)

NAME
       instr,  winstr, mvinstr, mvwinstr, innstr, winnstr, mvinnstr, mvwinnstr
       - get a string from a curses window

SYNOPSIS
       #include <ncursesw/curses.h>

       int instr(char * str);
       int winstr(WINDOW * win, char * str);
       int mvinstr(int y, int x, char * str);
       int mvwinstr(WINDOW * win, int y, int x, char * str);

       int innstr(char * str, int n);
       int winnstr(WINDOW * win, char * str, int n);
       int mvinnstr(int y, int x, char * str, int n);
       int mvwinnstr(WINDOW * win, int y, int x, char * str,
             int n);

DESCRIPTION
       winstr extracts a string from a curses window win, starting at the cur‐
       sor and stopping at the end of the line, and stores it in  str,  termi‐
       nating  it  with a null character and omitting any attributes and color
       pair identifier that curses associates with  each  character.   winnstr
       does  the same, but copies at most n characters from win.  A negative n
       implies no limit; winnstr then  works  like  winstr.   ncurses(3X)  de‐
       scribes the variants of these functions.

RETURN VALUE
       These  functions return the count of characters copied from win to str,
       or ERR upon failure.

       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

       •   str 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 winnstr may be implemented as macros.

       Reading a line that overflows the array pointed to by str  with  instr,
       winstr,  mvinstr, or mvwinstr causes undefined results.  Use of innstr,
       winnstr, mvinnstr, and mvwinnstr 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
       innstr,  winnstr,  mvinnstr,  and  mvwinnstr'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.

       X/Open Curses Issues 4 and 7 both state that  instr,  winstr,  mvinstr,
       and  mvwinstr  return OK rather than a character count.  This is likely
       an erratum.

       •   SVr3.1 and SVr4 implemented winstr as a wrapper around winnstr, re‐
           turning the latter's return value.  X/Open  Curses's  specification
           thus  may  have  been  an editorial solecism copied from System V's
           documentation (see below) by X/Open,  rather  than  an  intentional
           change.

       •   ncurses retains compatibility with System V curses behavior.

       SVr4  describes  a  successful  return  value only as “an integer value
       other than ERR”.

       SVr4 does not document whether n counts the null terminator that  these
       functions write to str.

HISTORY
       SVr3.1 (1987) introduced these functions.

SEE ALSO
       curs_inwstr(3X)  describes  comparable functions of the ncurses library
       in its wide-character configuration (ncursesw).

       curses(3X), curs_inch(3X), curs_inchstr(3X)


ncurses 6.5                       2025-03-01                    curs_instr(3x)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3