HP-UX Reference (11i v1 00/12) - 3 Library Functions A-M (vol 6)
__________________________________________________________________________________________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________________________________________________________________________________________
STANDARD Printed by: Nora Chuang [nchuang] STANDARD
/build/1111/BRICK/man3/!!!intro.3c
________________________________________________________________
___ ___
b
bkgrnd(3X) bkgrnd(3X)
(ENHANCED CURSES)
NAME
bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd — set or get background character and
rendition using a complex character
SYNOPSIS
#include <curses.h>
int bkgrnd(const cchar_t *wch);
void bkgrndset(const cchar_t *wch);
int getbkgrnd(cchar_t *wch);
int wbkgrnd(WINDOW *win, const cchar_t *wch);
void wbkgrndset(WINDOW *win, const cchar_t *wch);
int wgetbkgrnd(WINDOW *win, cchar_t *wch);
DESCRIPTION
The bkgrndset() and wbkgrndset() functions set the background property of the current or
specified window based on the information in wch.
The
bkgrnd() and wbkgrnd() functions 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 background rendition.
• Wherever the former background character appears, it is changed to the new background charac-
ter.
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 unspecified.
The getbkgrnd() and wgetbkgrnd() functions store, into the area pointed to by wch, the value of
the window’s background character and rendition.
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_intro(3X), subsection called Rendition, <curses.h>.
CHANGE HISTORY
First released in X/Open Curses, Issue 4.
HP-UX Release 11i: December 2000 − 1 − Section 3−−41
___
___