ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_print.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2010,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   * @Id: curs_print.3x,v 1.15 2020/03/28 19:06:28 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>curs_print 3x</TITLE>
38 <link rel="author" 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">curs_print 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>                                                  <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>mcprint</STRONG> - ship binary data to printer
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>mcprint(char</STRONG> <STRONG>*data,</STRONG> <STRONG>int</STRONG> <STRONG>len);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        This  function  uses  the <STRONG>mc5p</STRONG> or <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities, if they are
61        present, to ship given data to a printer attached to the terminal.
62
63        Note that the <STRONG>mcprint</STRONG> code has no way  to  do  flow  control  with  the
64        printer  or  to  know  how  much buffering it has.  Your application is
65        responsible for keeping the rate of writes to  the  printer  below  its
66        continuous  throughput  rate  (typically  about half of its nominal cps
67        rating).  Dot-matrix printers and 6-page-per-minute  lasers  can  typi-
68        cally  handle  80cps,  so a good conservative rule of thumb is to sleep
69        for a second after shipping each 80-character line.
70
71
72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        The <STRONG>mcprint</STRONG> function returns <STRONG>ERR</STRONG> if the  write  operation  aborted  for
74        some  reason.  In this case, <STRONG>errno</STRONG> will contain either an error associ-
75        ated with <STRONG>write(2)</STRONG> or one of the following:
76
77        ENODEV
78             Capabilities for printer redirection do not exist.
79
80        ENOMEM
81             Couldn't allocate sufficient memory to buffer the printer write.
82
83        When <STRONG>mcprint</STRONG> succeeds, it returns the  number  of  characters  actually
84        sent to the printer.
85
86
87 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
88        The <STRONG>mcprint</STRONG> call was designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and is not found in SVr4
89        curses, 4.4BSD curses, or any other previous version of curses.
90
91
92 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
93        Padding in the <STRONG>mc5p</STRONG>, <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities will not be interpreted.
94
95
96 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
97        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
98
99
100
101                                                                 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
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-BUGS">BUGS</a></li>
111 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
112 </ul>
113 </div>
114 </BODY>
115 </HTML>