X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgrnd.3x.html;h=e4b0143d42a66b138ddd5402a0219b61471a63ea;hp=c2b106344a5ac91a7c071aeb101c4a957c18a9a9;hb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;hpb=6a530b46563470c2ca73579d1994a0c8e275dd98
diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html
index c2b10634..e4b0143d 100644
--- a/doc/html/man/curs_bkgrnd.3x.html
+++ b/doc/html/man/curs_bkgrnd.3x.html
@@ -1,6 +1,6 @@
@@ -45,15 +45,13 @@
-
-
+
bkgrnd, wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wget-
bkgrnd - curses window complex background manipulation
routines
-
-
+
#include <curses.h>
int bkgrnd( const cchar_t *wch);
@@ -64,11 +62,9 @@
int wgetbkgrnd(WINDOW *win, cchar_t *wch);
-
-
+
-
-
+
The bkgrndset and wbkgrndset routines manipulate the back-
ground of the named window. The window background is a
cchar_t consisting of any combination of attributes (i.e.,
@@ -86,8 +82,7 @@
graphic rendition of the character put on the screen.
-
-
+
The bkgrnd and wbkgrnd functions set the background prop-
erty of the current or specified window and then apply
this setting to every character position in that window:
@@ -99,29 +94,30 @@
is changed to the new background character.
-
-
+
The getbkgrnd function returns the given window's current
- background character/attribute pair via the wch pointer.
+ background character/attribute pair via the wch pointer.
+ If the given window pointer is null, the character is not
+ updated (but no error returned).
-
-
+
Note that bkgrnd, bkgrndset, and getbkgrnd may be macros.
-
-
+
The bkgrndset and wbkgrndset routines do not return a
value.
Upon successful completion, the other functions return OK.
- Otherwise, they return ERR. A null window pointer is
- treated as an error.
+ Otherwise, they return ERR:
+ o A null window pointer is treated as an error.
-
-
+ o A null character pointer is treated as an error.
+
+
+
curses(3x), curs_bkgd(3x)