]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_bkgrnd.3x.html
ncurses 6.4 - patch 20231202
[ncurses.git] / doc / html / man / curs_bkgrnd.3x.html
index f5ffa7441afc5ddb3bdbe8079aec1f1cc295e71c..60ea015b8a48378dac5d576a93479c2527d8bf8b 100644 (file)
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_bkgrnd.3x,v 1.32 2023/11/25 14:01:49 tom Exp @
+  * @Id: curs_bkgrnd.3x,v 1.34 2023/12/02 21:30:00 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_bkgrnd 3x 2023-11-25 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_bkgrnd 3x 2023-12-02 ncurses 6.4 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_bkgrnd 3x 2023-11-25 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_bkgrnd 3x 2023-12-02 ncurses 6.4 Library calls</H1>
 <PRE>
 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>                  Library calls                 <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
 
 
 
 </PRE><H3><a name="h3-getbkgrnd">getbkgrnd</a></H3><PRE>
-       The <STRONG>getbkgrnd</STRONG> function returns the given  window's  current  background
-       character/attribute  pair  via  the  <EM>wch</EM>  pointer.  If the given window
-       pointer is null,  the  character  is  not  updated  (but  no  error  is
-       returned).
+       The <STRONG>getbkgrnd</STRONG> and <STRONG>wgetbkgrnd</STRONG> functions obtain the  given  or  specified
+       window's  current  background character and attribute pair and store it
+       via the <EM>wch</EM> pointer.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
        The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a value.
 
-       Upon  successful completion, the other functions return <STRONG>OK</STRONG>.  Otherwise,
+       Upon successful completion, the other functions return <STRONG>OK</STRONG>.   Otherwise,
        they return <STRONG>ERR</STRONG>:
 
-       <STRONG>o</STRONG>   A null window pointer is treated as an error.
+       <STRONG>o</STRONG>   A null <EM>WINDOW</EM> pointer is treated as an error.
 
-       <STRONG>o</STRONG>   A null character pointer is treated as an error.
+       <STRONG>o</STRONG>   A null <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM> pointer is treated as an error.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be available as macros.
 
        X/Open Curses does not provide details on how the rendition is changed.
-       This  implementation follows the approach used in SVr4 curses, which is
+       This implementation follows the approach used in SVr4 curses, which  is
        explained in the manual page for <STRONG>wbkgd</STRONG>.
 
 
 
 
 
-ncurses 6.4                       2023-11-25                   <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
+ncurses 6.4                       2023-12-02                   <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>