X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inchstr.3x.html;h=8b64d97b096649ce373fe81c435480bba7b7d51d;hp=4d12a400a0379dc2ecd788dc97cf99e77455538f;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72 diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index 4d12a400..8b64d97b 100644 --- a/doc/html/man/curs_inchstr.3x.html +++ b/doc/html/man/curs_inchstr.3x.html @@ -1,6 +1,7 @@ - -curs_inchstr 3x - +curs_inchstr 3X + -

curs_inchstr 3x

curs_inchstr 3X

-curs_inchstr(3x)                                              curs_inchstr(3x)
+curs_inchstr(3X)                                              curs_inchstr(3X)

NAME

-       inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr,
-       mvwinchstr, mvwinchnstr - get a string of characters (and attributes)
-       from a curses window
+       inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr,
+       mvwinchstr, mvwinchnstr - get a string of characters (and attributes)
+       from a curses window

SYNOPSIS

-       #include <curses.h>
+       #include <curses.h>
 
-       int inchstr(chtype *chstr);
-       int inchnstr(chtype *chstr, int n);
-       int winchstr(WINDOW *win, chtype *chstr);
-       int winchnstr(WINDOW *win, chtype *chstr, int n);
-       int mvinchstr(int y, int x, chtype *chstr);
-       int mvinchnstr(int y, int x, chtype *chstr, int n);
-       int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);
-       int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);
+       int inchstr(chtype *chstr);
+       int inchnstr(chtype *chstr, int n);
+       int winchstr(WINDOW *win, chtype *chstr);
+       int winchnstr(WINDOW *win, chtype *chstr, int n);
+
+       int mvinchstr(int y, int x, chtype *chstr);
+       int mvinchnstr(int y, int x, chtype *chstr, int n);
+       int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);
+       int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);

DESCRIPTION

-       These  routines  return  a  NULL-terminated array of chtype quantities,
+       These  routines  return  a  NULL-terminated array of chtype quantities,
        starting at the current cursor position in the named window and  ending
-       at  the  right  margin of the window.  The four functions with n as the
-       last argument, return a leading substring at  most  n  characters  long
-       (exclusive of the trailing (chtype)0).  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  chstr  [see
-       curs_inch(3x)].
+       at  the  right  margin of the window.  The four functions with n as the
+       last argument, return a leading substring at  most  n  characters  long
+       (exclusive of the trailing (chtype)0).  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  chstr  [see
+       curs_inch(3X)].

RETURN VALUE

-       All routines return the integer ERR upon failure and an  integer  value
-       other than ERR upon successful completion (the number of characters re-
+       All routines return the integer ERR upon failure and an  integer  value
+       other than ERR upon successful completion (the number of characters re-
        trieved, exclusive of the trailing 0).
 
        X/Open Curses defines no error conditions.  In this implementation:
 
-       o   If the win parameter is null, an error is returned,
+       o   If the win parameter is null, an error is returned,
 
-       o   If the chstr parameter is null, an error is returned,
+       o   If the chstr parameter is null, an error is returned,
 
        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
+       wmove, and return an error if the position is outside the window, or if
        the window pointer is null.

NOTES

-       Note that all routines except winchnstr may be macros.  SVr4  does  not
+       Note that all routines except winchnstr may be macros.  SVr4  does  not
        document whether the result string is zero-terminated; it does not doc-
        ument whether a length limit argument includes any trailing 0;  and  it
        does not document the meaning of the return value.
@@ -101,18 +103,18 @@

PORTABILITY

        These  functions are described in the XSI Curses standard, Issue 4.  It
        is no more specific than the SVr4 documentation on the trailing 0.   It
-       does specify that the successful return of the functions is OK.
+       does specify that the successful return of the functions is OK.