ncurses 6.0 - patch 20180106
[ncurses.git] / doc / html / man / legacy_coding.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2005-2016,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * Author: Thomas E. Dickey
30   * @Id: legacy_coding.3x,v 1.6 2017/03/15 08:14:25 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>legacy_coding 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">legacy_coding 3x</H1>
43 <PRE>
44 <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>                                            <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>use_legacy_coding</STRONG> - override locale-encoding checks
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>use_legacy_coding(int</STRONG> <STRONG>level);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        The  <STRONG>use_legacy_coding</STRONG>  function is an extension to the curses library.
61        It allows the caller to change  the  result  of  <STRONG>unctrl</STRONG>,  and  suppress
62        related checks within the library that would normally cause nonprinting
63        characters to be rendered in visible form.   This  affects  only  8-bit
64        characters.
65
66        The <EM>level</EM> parameter controls the result:
67
68               0    the library functions normally, rendering nonprinting char-
69                    acters as described in <STRONG>unctrl</STRONG>.
70
71               1    the  library  ignores  <STRONG>isprintf</STRONG>  for  codes  in  the  range
72                    160-255.
73
74               2    the  library  ignores  <STRONG>isprintf</STRONG>  for  codes  in  the  range
75                    128-255.  It also modifies the output  of  <STRONG>unctrl</STRONG>,  showing
76                    codes in the range 128-159 as is.
77
78
79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80        If  the  screen has not been initialized, or the <EM>level</EM> parameter is out
81        of range, the function returns <STRONG>ERR</STRONG>.  Otherwise, it returns the previous
82        level: <STRONG>0</STRONG>, <STRONG>1</STRONG> or <STRONG>2</STRONG>.
83
84
85 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
86        This  routine  is specific to ncurses.  It was not supported on Version
87        7, BSD or System V implementations.  It is recommended  that  any  code
88        depending on ncurses extensions be conditioned using NCURSES_VERSION.
89
90
91 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
92        <STRONG>unctrl</STRONG>.
93
94
95 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
96        Thomas Dickey (to support lynx's font-switching feature).
97
98
99
100                                                              <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
101 </PRE>
102 <div class="nav">
103 <ul>
104 <li><a href="#h2-NAME">NAME</a></li>
105 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
106 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
107 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
108 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
109 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
110 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
111 </ul>
112 </div>
113 </BODY>
114 </HTML>