tigetnum Subroutine
Purpose
Gets the value of terminal's numeric capability.
Library
Curses Library (libcurses.a)
Syntax
#include <curses.h>
#include <term.h>tigetnum( CapName)
register char *CapName;
register char *CapName;
Description
The tigetnum subroutine returns the value of terminal's numeric capability. Use this subroutine to get a capability for the current terminal. When successful, this subroutine returns the current value of the capability specified by the CapName parameter. Otherwise, if it is not a numeric value, this subroutine returns -2.
Note: The tigetnum subroutine
is a low-level routine. Use this subroutine only if your application
must deal directly with the terminfo database to handle certain terminal
capabilities (for example, programming function keys).
Return Values
Upon successful completion, the tigetnum subroutine returns the value of terminal's numeric capability.
| Item | Description |
|---|---|
| -2 | Indicates the value specified by the CapName parameter is not numeric. |
Parameters
| Item | Description |
|---|---|
| CapName | Identifies the terminal capability to check for. |
Example
To determine if number of labels is a defined numeric capability for the current terminal, use:
rc = tigetnum("nlab");