doc/html/man/legacy_coding.3x.html

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