ncurses 4.1
[ncurses.git] / include / unctrl.h.in
1 /***************************************************************************
2 *                            COPYRIGHT NOTICE                              *
3 ****************************************************************************
4 *                ncurses is copyright (C) 1992-1995                        *
5 *                          Zeyd M. Ben-Halim                               *
6 *                          zmbenhal@netcom.com                             *
7 *                          Eric S. Raymond                                 *
8 *                          esr@snark.thyrsus.com                           *
9 *                                                                          *
10 *        Permission is hereby granted to reproduce and distribute ncurses  *
11 *        by any means and for any fee, whether alone or as part of a       *
12 *        larger distribution, in source or in binary form, PROVIDED        *
13 *        this notice is included with any such distribution, and is not    *
14 *        removed from any of its header files. Mention of ncurses in any   *
15 *        applications linked with it is highly appreciated.                *
16 *                                                                          *
17 *        ncurses comes AS IS with no warranty, implied or expressed.       *
18 *                                                                          *
19 ***************************************************************************/
20
21 /*
22  * unctrl.h
23  *
24  * Display a printable version of a control character.
25  * Control characters are displayed in caret notation (^x), DELETE is displayed
26  * as ^?. Printable characters are displayed as is.
27  *
28  * The returned pointer points to a static buffer which gets overwritten by
29  * each call. Therefore, you must copy the resulting string to a safe place
30  * before calling unctrl() again.
31  *
32  */
33
34 /* $Id: unctrl.h.in,v 1.5 1997/04/26 23:04:09 tom Exp $ */
35
36 #ifndef _UNCTRL_H
37 #define _UNCTRL_H       1
38
39 #undef  NCURSES_VERSION
40 #define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 #include <curses.h>
47
48 extern NCURSES_CONST char *unctrl(chtype);
49
50 #ifdef __cplusplus
51 }
52 #endif
53
54 #endif /* _UNCTRL_H */