Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
X/Open Curses Library Functionstigetflag(3XCURSES)


NAME

 tigetflag, tigetnum, tigetstr, tparm - return the value of a terminfo capability

SYNOPSIS

 
#include <term.h>
int tigetflag(char *capname);
 int tigetnum(char *capname);
 char *tigetstr(char *capname);
 char *tparm(char *cap, long p1, long p2, long p3, long p4, long p5, long p6, long p7, long p8, long p9);

PARAMETERS

 
capname
Is the name of the terminfo capability for which the value is required.
cap
Is a pointer to a string capability.
p1...p9
Are the parameters to be instantiated.

DESCRIPTION

 

The tigetflag(), tigetnum(), and tigetstr() functions return values for terminfo capabilities passed to them.

The following null-terminated arrays contain the capnames, the termcap codes and full C names for each of the terminfo variables.

 
char *boolnames, *boolcodes, *boolfnames
char *numnames, *numcodes, *numfnames
char *strnames, *strcodes, *strfnames

The tparm() function instantiates a parameterized string using nine arguments. The string is suitable for output processing by tputs().

RETURN VALUES

 

On success, the tigetflg(), tigetnum(), and tigetstr() functions return the specified terminfo capability.

tigetflag() returns -1 if capname is not a Boolean capability.

tigetnum() returns -2 if capname is not a numeric capability.

tigetstr() returns (char *)-1 if capname is not a string capability.

On success, the tparm() function returns cap in a static buffer with the parameterization resolved. Otherwise, it returns a null pointer.

ERRORS

 

None.

SEE ALSO

 

tgetent(3XCURSES), terminfo(4)


SunOS 5.9Go To TopLast Changed 1 Jun 1996

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.