X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inchstr.3x.html;h=b231595073290765799be8fe3a23dfa0da399596;hp=5688c02aa2e235c2d4df1b79e28b2c0511376e56;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index 5688c02a..b2315950 100644 --- a/doc/html/man/curs_inchstr.3x.html +++ b/doc/html/man/curs_inchstr.3x.html @@ -1,80 +1,139 @@ + + + + + +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
+
NAME
+       inchstr, inchnstr, winchstr, winchnstr, mvinchstr,
+       mvinchnstr, mvwinchstr, mvwinchnstr - get a string of
+       characters (and attributes) from a curses window
 
 
 

-
SYNOPSIS
-       #include <curses.h>
+
SYNOPSIS
+       #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
+
DESCRIPTION
+       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  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)].
+       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
+
RETURN VALUE
+       All routines return the integer ERR upon  failure  and  an
+       integer  value  other  than ERR upon successful completion
        (the number of  characters  retrieved,  exclusive  of  the
        trailing 0).
 
+       No  error  conditions are defined.  If the chstr parameter
+       is null, no data is returned, and the return value is  ze-
+       ro.
+
+       Functions  with a "mv" prefix first perform a cursor move-
+       ment using 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 document whether the result string is 0-ter-
-       minated; it does not document whether a length limit argu-
-       ment includes any trailing 0; and it does not document the
-       meaning of the return value.
+
NOTES
+       Note  that  all  routines  except winchnstr may be macros.
+       SVr4 does not document whether the result string is  zero-
+       terminated;  it  does  not document whether a length limit
+       argument includes any trailing 0; and it does not document
+       the meaning of the return value.
 
 
 

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

-
SEE ALSO
-       curses(3x), curs_inch(3x).
+
SEE ALSO
+       curses(3x), curs_inch(3x).
 
+       Comparable functions in the wide-character (ncursesw)  li-
+       brary are described in curs_in_wchstr(3x).
 
 
 
+                                                       curs_inchstr(3x)
 

-

-

-Man(1) output converted with
-man2html
-

+

+
+