HP-UX Reference (11i v2 04/09) - 3 Library Functions A-M (vol 6)

bkgd(3X) bkgd(3X)

(ENHANCED CURSES)

NAME

bkgd, bkgdset, getbkgd, wbkgd, wbkgdset — set or get background character and rendition using a

single-byte character

SYNOPSIS

#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 set the background property of the current or speciﬁed

window based on the information in ch.Ifch refers to a multi-column character, the results are

undeﬁned.

The

bkgd() and wbkgd() functions set the background property of the current or speciﬁed 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 background rendition.

• Wherever the former background character appears, it is changed to the new background char-

acter.

The

getbkgd() function extracts the speciﬁed 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.

Upon successful completion,

getbkgd() returns the speciﬁed window’s background character and rendi-

tion. Otherwise, it returns (chtype)ERR.

ERRORS

No errors are deﬁned.

APPLICATION USAGE

These functions are only guaranteed to operate reliably on character sets in which each character ﬁts into

a single byte, whose attributes can be expressed using only constants with the A_ preﬁx.