curstermattrs(3X) curstermattrs(3X)

NAME
       bbaauuddrraattee,  eerraasseecchhaarr,  eerraasseewwcchhaarr, hhaassiicc, hhaassiill, kkiillllcchhaarr, kkiillllwwcchhaarr,
       lloonnggnnaammee, tteerrmmaattttrrss, tteerrmmaattttrrss, tteerrmmnnaammee -  ccuurrsseess  environment  query
       routines

SYNOPSIS
       ##iinncclluuddee <>

       iinntt bbaauuddrraattee((vvooiidd));;
       cchhaarr eerraasseecchhaarr((vvooiidd));;
       iinntt eerraasseewwcchhaarr((wwcchhaarrtt **ch));;
       bbooooll hhaassiicc((vvooiidd));;
       bbooooll hhaassiill((vvooiidd));;
       cchhaarr kkiillllcchhaarr((vvooiidd));;
       iinntt kkiillllwwcchhaarr((wwcchhaarrtt **ch));;
       cchhaarr **lloonnggnnaammee((vvooiidd));;
       aattttrrtt tteerrmmaattttrrss((vvooiidd));;
       cchhttyyppee tteerrmmaattttrrss((vvooiidd));;
       cchhaarr **tteerrmmnnaammee((vvooiidd));;

DESCRIPTION
       The  bbaauuddrraattee  routine  returns  the output speed of the terminal.  The
       number returned is in bits per second, for  example  99660000,  and  is  an
       integer.

       The eerraasseecchhaarr routine returns the user's current erase character.

       The  eerraasseewwcchhaarr routine stores the current erase character in the loca-
       tion referenced by ch.  If no erase character  has  been  defined,  the
       routine fails and the location referenced by ch is not changed.

       The  hhaassiicc  routine  is  true  if the terminal has insert- and delete-
       character capabilities.

       The hhaassiill routine is true if the terminal has insert- and  delete-line
       capabilities, or can simulate them using scrolling regions.  This might
       be used to determine if it would be appropriate  to  turn  on  physical
       scrolling using ssccrroollllookk.

       The kkiillllcchhaarr routine returns the user's current line kill character.

       The  kkiillllwwcchhaarr  routine  stores  the current line-kill character in the
       location referenced by ch.  If no line-kill character has been defined,
       the routine fails and the location referenced by ch is not changed.

       The  lloonnggnnaammee  routine  returns a pointer to a static area containing a
       verbose description of the current terminal.  The maximum length  of  a
       verbose  description  is  128 characters.  It is defined only after the
       call to iinniittssccrr or nneewwtteerrmm.  The area is overwritten by  each  call  to
       nneewwtteerrmm  and  is not restored by sseetttteerrmm, so the value should be saved
       between calls to nneewwtteerrmm if lloonnggnnaammee is going to be used with  multiple
       terminals.

       If  a given terminal doesn't support a video attribute that an applica-
       tion program is trying to use, ccuurrsseess may substitute a different  video
       attribute for it.  The tteerrmmaattttrrss and tteerrmmaattttrrss functions return a log-
       ical OORR of all video attributes supported by the terminal using A  and
       WA  constants  respectively.  This information is useful when a ccuurrsseess
       program needs complete control over the appearance of the screen.

       The tteerrmmnnaammee routine returns the terminal name used by sseettuupptteerrmm.

RREETTUURRNN VVAALLUUEE
       lloonnggnnaammee and tteerrmmnnaammee return NNUULLLL on error.

       Routines that return an integer return EERRRR upon failure  and  OOKK  (SVr4
       only  specifies "an integer value other than EERRRR") upon successful com-
       pletion.

NNOOTTEESS
       Note that tteerrmmaattttrrss may be a macro.

PPOORRTTAABBIILLIITTYY
       The XSI Curses standard, Issue 4 describes these functions.  It changes
       the  return type of tteerrmmaattttrrss to the new type aattttrrtt.  Most versions of
       curses truncate the result returned by tteerrmmnnaammee to 14 characters.

SEE ALSO
       ccuurrsseess(3X), ccuurrssiinniittssccrr(3X), ccuurrssoouuttooppttss(3X)



                                                            curstermattrs(3X)