tgetstr Subroutine

Purpose

Returns the string entry for the specified termcap identifier.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

char *tgetstr( ID,  Area)
char *ID, **Area;

Description

The tgetstr subroutine returns the string entry for the specified termcap identifier. This subroutine is provided for binary compatibility with applications that use the termcap file.

Parameters

Item Description
Area Contains the string entry for the specified termcap identifier. This also is returned to the calling program.
ID Specifies the 2-character string that contains the termcap identifier.

Return Values

The tgetstr subroutine returns the string entry for the ID parameter, which is a 2-character string that contains a termcap identifier.

Item Description
0 Returned if ID is not found or not a string capability.