notcurses/doc/man/man3/notcurses_stop.3.md

35 lines
905 B
Markdown
Raw Normal View History

2020-01-02 02:23:11 +00:00
% notcurses_stop(3)
% nick black <nickblack@linux.com>
2020-05-11 01:36:48 +00:00
% v1.4.0
2020-01-02 02:23:11 +00:00
# NAME
notcurses_stop - free up resources and restore initial terminal state
2020-01-02 02:23:11 +00:00
# SYNOPSIS
**#include <notcurses/notcurses.h>**
2020-01-02 02:23:11 +00:00
**int notcurses_stop(struct notcurses* nc);**
# DESCRIPTION
**notcurses_stop** frees up any resources associated with the
**struct notcurses** provided as **nc**, and attempts to restore the terminal to its
state prior to calling notcurses_init(3). It also unregisters any signal
handlers put into place by notcurses_init(3). **nc** must not be used following
2020-01-13 22:55:54 +00:00
the call, and all references to ncplanes, cells, etc. are invalidated.
2020-01-02 02:23:11 +00:00
# NOTES
Behavior is undefined if other threads are working with **nc** when or after
this function is called. It is unlikely to be good.
# RETURN VALUES
On success, 0 is returned. Otherwise, a negative value is returned.
# SEE ALSO
**notcurses(3)**, **notcurses_init(3)**