bkgd(3X) bkgd(3X)
NAME
bkgd, bkgdset, getbkgd, wbkgd, wbkgdset - turn off the previous back-
ground attributes
SYNOPSIS
cc [flag ...] file ... -lcurses [library ...]
#include <curses.h>
int bkgd(chtype ch);
void bkgdset(chtype ch);
chtype getbkgd(WINDOW *win);
int wbkgd(WINDOW *win, chtype ch);
void wbkgdset(WINDOW *win, chtype ch);
DESCRIPTION
The bkgdset() and wbkgdset() functions turn off the previous back-
ground attributes, logical OR the requested attributes into the window
rendition, and set the background property of the current or specified
window based on the information in ch. If ch refers to a multi-column
character, the results are undefined.
The bkgd() and wbkgd() functions turn off the previous background
attributes, logical OR the requested attributes into the window rendi-
tion, and set the background property of the current or specified win-
dow and then apply this setting to every character position in that
window:
- The rendition of every character on the screen is changed to the
new window rendition.
- Wherever the former background character appears, it is changed to
the new background character.
The getbkgd() function extracts the specified window's background
character and rendition.
RETURN VALUE
Upon successful completion, bkgd() and wbkgd() return OK. Otherwise,
they return ERR.
The bkgdset() and wbkgdset() functions do not return a value.
Page 1 Reliant UNIX 5.44 Printed 11/98
bkgd(3X) bkgd(3X)
Upon successful completion, getbkgd() returns the specified window's
background character and rendition. Otherwise, it returns (chtype)ERR.
ERRORS
No errors are defined.
NOTES
These functions are only guaranteed to operate reliably on character
sets in which each character fits into a single byte, whose attributes
can be expressed using only constants with the A prefix.
SEE ALSO
curses(3X), curses(5).
Page 2 Reliant UNIX 5.44 Printed 11/98