Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tigetstr(3XCURSES)

Name

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

Synopsis

cc [ flag... ] file... –I /usr/xpg4/include –L /usr/xpg4/lib \
–R /usr/xpg4/lib –lcurses [ library... ]

c89 [ flag... ] file... –lcurses [ library... ]

#include <term.h>

int tigetflag(char *capname);
int tigetnum(char *capname);
char *tigetstr(char *capname);
char *tiparm(const char *cap, ...);
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 tiparm() and tparm() functions take cap as a string capability. If cap is parameterized, these functions resolve the parameterization. The resulting string is suitable for output processing by the tputs() function.

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 successful completion, the tiparm() and tparm() functions return the capability pointed to by cap in static buffer with parameterization resolved. Otherwise, they return a null pointer.

Errors

None.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard

See Also

libcurses(3XCURSES), tgetent(3XCURSES), terminfo(5), attributes(7), standards(7)