bkgrnd(3X) bkgrnd(3X)
NAME
bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd - turn
off the previous background attributes
SYNOPSIS
cc [flag ...] file ... -lcurses [library ...]
#include <curses.h>
int bkgrnd(const cchart *wch);
void bkgrndset(const cchart *wch);
int getbkgrnd(cchart *wch);
int wbkgrnd(WINDOW *win, const cchart *wch);
void wbkgrndset(WINDOW *win, const cchart *wch);
int wgetbkgrnd(WINDOW *win, cchart *wch);
DESCRIPTION
The bkgrndset() and wbkgrndset() functions turn off the previous back-
ground attributes, OR the requested attributes into the window rendi-
tion, and set the background property of the current or specified win-
dow based on the information in wch.
The bkgrnd() and wbkgrnd() functions turn off the previous background
attributes, OR the requested attributes into the window rendition, and
set the background property of the current or specified window 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.
If wch refers to a non-spacing complex character for bkgrnd(),
bkgrndset(), wbkgrnd() and wbkgrndset(), then wch is added to the
existing spacing complex character that is the background character.
If wch refers to a multi-column character, the results are unspeci-
fied.
The getbkgrnd() and wgetbkgrnd() functions store, into the area
pointed to by wch, the value of the window's background character and
rendition.
Page 1 Reliant UNIX 5.44 Printed 11/98
bkgrnd(3X) bkgrnd(3X)
RETURN VALUE
The bkgrndset() and wbkgrndset() functions do not return a value.
Upon successful completion, the other functions return OK. Otherwise,
they return ERR.
ERRORS
No errors are defined.
SEE ALSO
curses(3X), curses(5).
Page 2 Reliant UNIX 5.44 Printed 11/98