cursbkgd(3X) cursbkgd(3X)

NAME
       bbkkggddsseett,  wwbbkkggddsseett,  bbkkggdd,  wwbbkkggdd,  ggeettbbkkggdd  - ccuurrsseess window background
       manipulation routines

SYNOPSIS
       ##iinncclluuddee <>

       vvooiidd bbkkggddsseett((cchhttyyppee cchh));;
       vvooiidd wwbbkkggddsseett((WWIINNDDOOWW **wwiinn,, cchhttyyppee cchh));;
       iinntt bbkkggdd((cchhttyyppee cchh));;
       iinntt wwbbkkggdd((WWIINNDDOOWW **wwiinn,, cchhttyyppee cchh));;
       cchhttyyppee ggeettbbkkggdd((WWIINNDDOOWW **wwiinn));;

DESCRIPTION
       The bbkkggddsseett and wwbbkkggddsseett routines  manipulate  the  background  of  the
       named window.  The window background is a cchhttyyppee consisting of any com-
       bination  of  attributes  (i.e.,  rendition)  and  a  character.    The
       attribute part of the background is combined (OR'ed) with all non-blank
       characters that are written into the  window  with  wwaaddddcchh.   Both  the
       character  and  attribute parts of the background are combined with the
       blank characters.  The background becomes a property of  the  character
       and  moves  with  the character through any scrolling and insert/delete
       line/character operations.

       To the extent possible on a particular terminal, the attribute part  of
       the  background  is displayed as the graphic rendition of the character
       put on the screen.

       The bbkkggdd and wwbbkkggdd functions 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 background rendition.

              Wherever  the former background character appears, it is changed
              to the new background character.

       The ggeettbbkkggdd function returns  the  given  window's  current  background
       character/attribute pair.

RREETTUURRNN VVAALLUUEE
       The  routines  bbkkggdd and wwbbkkggdd return the integer OOKK.  The SVr4.0 manual
       says "or a non-negative integer if iimmmmeeddookk is set", but this appears to
       be an error.

NNOOTTEESS
       Note that bbkkggddsseett and bbkkggdd may be macros.

PPOORRTTAABBIILLIITTYY
       These  functions are described in the XSI Curses standard, Issue 4.  It
       specifies that bbkkggdd and wwbbkkggdd return EERRRR  on  failure.   but  gives  no
       failure conditions.

SEE ALSO
       ccuurrsseess(3X), ccuurrssaaddddcchh(3X), ccuurrssaattttrr(3X), ccuurrssoouuttooppttss(3X)



                                                                 cursbkgd(3X)