tigetflag(3xcurses)

1tigetflag(3XCURSES)     X/Open Curses Library Functions    tigetflag(3XCURSES)
2
3
4

NAME

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

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <term.h>
16
17       int tigetflag(char *capname);
18
19
20       int tigetnum(char *capname);
21
22
23       char *tigetstr(char *capname);
24
25
26       char *tparm(char *cap, long p1, long p2, long p3, long p4, long p5,
27            long p6, long p7,long p8, long p9);
28
29

PARAMETERS

31       capname    Is the name of the terminfo capability for which  the  value
32                  is  required.
33
34
35       cap        Is a pointer to a string capability.
36
37
38       p1...p9    Are the parameters to be instantiated.
39
40

DESCRIPTION

42       The  tigetflag(),  tigetnum(),  and tigetstr() functions  return values
43       for terminfo capabilities passed to them.
44
45
46       The following null-terminated arrays contain the capnames,  the termcap
47       codes and full C names for each of the terminfo variables.
48
49         char *boolnames, *boolcodes, *boolfnames
50         char *numnames, *numcodes, *numfnames
51         char *strnames, *strcodes, *strfnames
52
53
54
55       The  tparm()  function  instantiates a parameterized string using  nine
56       arguments. The string is suitable for output processing by tputs().
57

RETURN VALUES

59       On success, the tigetflg(), tigetnum(), and tigetstr() functions return
60       the specified terminfo capability.
61
62
63       tigetflag() returns −1 if capname is not a Boolean capability.
64
65
66       tigetnum() returns −2 if capname is not a numeric capability.
67
68
69       tigetstr() returns (char *)−1 if capname is not a string  capability.
70
71
72       On  success,  the  tparm() function returns cap in a static buffer with
73       the parameterization resolved.  Otherwise, it returns a null pointer.
74

ERRORS

76       None.
77

ATTRIBUTES

79       See attributes(5) for descriptions of the following attributes:
80
81
82
83
84       ┌─────────────────────────────┬─────────────────────────────┐
85       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
86       ├─────────────────────────────┼─────────────────────────────┤
87       │Interface Stability          │Standard                     │
88       ├─────────────────────────────┼─────────────────────────────┤
89       │MT-Level                     │Unsafe                       │
90       └─────────────────────────────┴─────────────────────────────┘
91