curs_initscr()

NAME

initscr(), newterm(), endwin(), isendwin(), set_term(), delscreen() - curses screen initialization and manipulation routines

SYNOPSIS 

#include <curses.h>


WINDOW *initscr(void);
int endwin(void);
int isendwin(void);
SCREEN *newterm(const char *type, FILE *outfd, FILE *infd);
SCREEN *set_term(SCREEN *new);
void delscreen(SCREEN *sp);

DESCRIPTION

initscr(3) is normally the first curses routine to call when initializing a program. A few special routines sometimes need to be called before it; these are slk_init(3), filter(3), ripoffline(3), and use_env(3). For multiple-terminal applications, newterm(3) may be called before initscr(3).

The initscr code determines the terminal type and initializes all curses data structures. initscr also causes the first call to refresh(3) to clear the screen. If errors occur, initscr(3) writes an appropriate error message to standard error and exits; otherwise, a pointer is returned to stdscr

A program that outputs to more than one terminal should use the newterm(3) routine for each terminal instead of initscr(3). A program that needs to inspect capabilities, so it can continue to run in a line-oriented mode if the terminal cannot support a screen-oriented program, would also use newterm(3). The routine newterm(3) should be called once for each terminal. It returns a variable of type SCREEN * which should be saved as a reference to that terminal. The arguments are the type of the terminal to be used in place of the value of TERM, a file pointer for output to the terminal, and another file pointer for input from the terminal (if type is NULL, the value of TERM will be used). The program must also call endwin(3) for each terminal being used before exiting from curses. If newterm(3) is called more than once for the same terminal, the first terminal referred to must be the last one for which endwin(3) is called.

A program should always call endwin(3) before exiting or escaping from curses mode temporarily. This routine restores tty modes, moves the cursor to the lower left-hand corner of the screen and resets the terminal into the proper non-visual mode. Calling refresh(3) or doupdate(3) after a temporary escape causes the program to resume visual mode.

The isendwin(3) routine returns TRUE if endwin(3) has been called without any subsequent calls to wrefresh(3), and FALSE otherwise.

The set_term(3) routine is used to switch between different terminals. The screen reference new becomes the new current terminal. The previous terminal is returned by the routine. This is the only routine which manipulates SCREEN pointers; all other routines affect only the current terminal.

The delscreen(3) routine frees storage associated with the SCREEN data structure. The endwin(3) routine does not do this, so delscreen(3) should be called after endwin(3) if a particular SCREEN is no longer needed.

RETURN VALUE

endwin(3) returns the integer ERR upon failure and OK upon successful completion.

Routines that return pointers always return NULL on error.

NOTES

Note that initscr(3) and newterm(3) may be macros.

PORTABILITY

These functions are described in the XSI Curses standard, Issue 4. It specifies that portable applications must not call initscr(3) more than once.

SEE ALSO

curses(3)

curs_kernel(3)

curs_refresh(3)

curs_slk(3)

curs_util(3)