MyWebUniversity.com Home Page
 



Darwin Mac OS X man pages main menu
curstermattrs(3X)                                          curstermattrs(3X)



NAME
       baudrate,  erasechar,  erasewchar, hasic, hasil, killchar, killwchar,
       longname, termattrs, termattrs, termname -  curses  environment  query
       routines

SYNOPSIS
       ##include <>

       int baudrate(void);;
       char erasechar(void);;
       int erasewchar(wchart **ch);;
       bool hasic(void);;
       bool hasil(void);;
       char killchar(void);;
       int killwchar(wchart **ch);;
       char **longname(void);;
       attrt termattrs(void);;
       chtype termattrs(void);;
       char **termname(void);;

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

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

       The  erasewchar 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  hasic  routine  is  true  if the terminal has insert- and delete-
       character capabilities.

       The hasil 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 scrollok.

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

       The  killwchar  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  longname  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 initscr or newterm.  The area is overwritten by  each  call  to
       newterm  and  is not restored by setterm, so the value should be saved
       between calls to newterm if longname 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, curses may substitute a different  video
       attribute for it.  The termattrs and termattrs functions return a log-
       ical OR of all video attributes supported by the terminal using A  and
       WA  constants  respectively.  This information is useful when a curses
       program needs complete control over the appearance of the screen.

       The termname routine returns the terminal name used by setupterm.

RETURN VALUE
       longname and termname return NUL on error.

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

NOTES
       Note that termattrs may be a macro.

PORTABILITY
       The XSI Curses standard, Issue 4 describes these functions.  It changes
       the  return type of termattrs to the new type attrt.  Most versions of
       curses truncate the result returned by termname to 14 characters.

SEE ALSO
       curses(3X), cursinitscr(3X), cursoutopts(3X)



                                                            curstermattrs(3X)
Darwin Mac OS X man pages main menu

Contact us      |       About us      |       Term of use      |       Copyright © 2000-2010 MyWebUniversity.com ™