X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inchstr.3x.html;h=f0f9a707380cd2d259ff8c3265f6cecb88bf85ba;hp=5688c02aa2e235c2d4df1b79e28b2c0511376e56;hb=a90dd7b66fa711acd24d8181ea20e4f57d4b36cd;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index 5688c02a..f0f9a707 100644 --- a/doc/html/man/curs_inchstr.3x.html +++ b/doc/html/man/curs_inchstr.3x.html @@ -1,80 +1,130 @@ + + + + + +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
 
 
-
-

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);
+

NAME

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

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  character or the attribute alone from any position in
-       the chstr [see curs_inch(3x)].
+

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);
 
-
-

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).
 
+

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  character
+       or   the   attribute   alone  from  any  position  in  the  chstr  [see
+       curs_inch(3x)].
 
-
-

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.
 
+

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-
+       trieved, exclusive of the trailing 0).
 
-
-

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.
+       X/Open Curses defines no error conditions.  In this implementation:
 
+       o   If the win parameter is null, an error is returned,
 
-
-

SEE ALSO

-       curses(3x), curs_inch(3x).
+       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
+       the window pointer is null.
+
+
+

NOTES

+       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.
+
+
+

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.
+
+
+

SEE ALSO

+       curses(3x), curs_inch(3x).
 
+       Comparable  functions  in the wide-character (ncursesw) library are de-
+       scribed in curs_in_wchstr(3x).
 
 
 
+                                                              curs_inchstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +