diff options
Diffstat (limited to 'doc/html/man/curs_inchstr.3x.html')
| -rw-r--r-- | doc/html/man/curs_inchstr.3x.html | 120 |
1 files changed, 60 insertions, 60 deletions
diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index bff908d..f0f9a70 100644 --- a/doc/html/man/curs_inchstr.3x.html +++ b/doc/html/man/curs_inchstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright 2018,2020 Thomas E. Dickey * + * Copyright 1998-2010,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -27,33 +27,32 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp @ + * @Id: curs_inchstr.3x,v 1.19 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_inchstr 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_inchstr 3x</H1> -<HR> +<H1 class="no-header">curs_inchstr 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> +<STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>, - <STRONG>mvinchnstr</STRONG>, <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a string of - characters (and attributes) from a <STRONG>curses</STRONG> window +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>, <STRONG>mvinchnstr</STRONG>, + <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a string of characters (and attributes) + from a <STRONG>curses</STRONG> window -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>int</STRONG> <STRONG>inchstr(chtype</STRONG> <STRONG>*chstr);</STRONG> @@ -63,68 +62,69 @@ <STRONG>int</STRONG> <STRONG>mvinchstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> <STRONG>int</STRONG> <STRONG>mvinchnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> <STRONG>int</STRONG> <STRONG>mvwinchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> - <STRONG>int</STRONG> <STRONG>mvwinchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> - <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - These routines return a NULL-terminated array of <STRONG>chtype</STRONG> - quantities, starting at the current cursor position in the - named window and ending at the right margin of the window. - The four functions with <EM>n</EM> as the last argument, return a - leading substring at most <EM>n</EM> characters long (exclusive of - the trailing (chtype)0). Constants defined in <STRONG><curses.h></STRONG> - can be used with the <STRONG>&</STRONG> (logical AND) operator to extract - the character or the attribute alone from any position in - the <EM>chstr</EM> [see <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>]. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + These routines return a NULL-terminated array of <STRONG>chtype</STRONG> quantities, + starting at the current cursor position in the named window and ending + at the right margin of the window. The four functions with <EM>n</EM> as the + last argument, return a leading substring at most <EM>n</EM> characters long + (exclusive of the trailing (chtype)0). Constants defined in <STRONG><curses.h></STRONG> + can be used with the <STRONG>&</STRONG> (logical AND) operator to extract the character + or the attribute alone from any position in the <EM>chstr</EM> [see + <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>]. -</PRE> -<H2>RETURN VALUE</H2><PRE> - All routines return the integer <STRONG>ERR</STRONG> upon failure and an - integer value other than <STRONG>ERR</STRONG> upon successful completion - (the number of characters retrieved, exclusive of the - trailing 0). +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an integer value + other than <STRONG>ERR</STRONG> upon successful completion (the number of characters re- + trieved, exclusive of the trailing 0). - No error conditions are defined. If the <EM>chstr</EM> parameter - is null, no data is returned, and the return value is ze- - ro. + X/Open Curses defines no error conditions. In this implementation: - Functions with a "mv" prefix first perform a cursor move- - ment using <STRONG>wmove</STRONG>, and return an error if the position is - outside the window, or if the window pointer is null. + <STRONG>o</STRONG> If the <EM>win</EM> parameter is null, an error is returned, + <STRONG>o</STRONG> If the <EM>chstr</EM> parameter is null, an error is returned, -</PRE> -<H2>NOTES</H2><PRE> - Note that all routines except <STRONG>winchnstr</STRONG> 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. + Functions with a "mv" prefix first perform a cursor movement using + <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if + the window pointer is null. -</PRE> -<H2>PORTABILITY</H2><PRE> - 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 <STRONG>OK</STRONG>. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + Note that all routines except <STRONG>winchnstr</STRONG> 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. -</PRE> -<H2>SEE ALSO</H2><PRE> +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + 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 <STRONG>OK</STRONG>. + + +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>. - Comparable functions in the wide-character (ncursesw) li- - brary are described in <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>. + Comparable functions in the wide-character (ncursesw) library are de- + scribed in <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>. - <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |