ncurses 5.4
[ncurses.git] / doc / html / man / curs_print.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2002,2003 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.6 2003/05/10 20:33:49 jmc Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_print 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_print 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>                                     <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
50        <STRONG>mcprint</STRONG> - ship binary data to printer
51
52
53 </PRE>
54 <H2>SYNOPSIS</H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>int</STRONG> <STRONG>mcprint(char</STRONG> <STRONG>*data,</STRONG> <STRONG>int</STRONG> <STRONG>len);</STRONG>
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        This  function  uses the <STRONG>mc5p</STRONG> or <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities,
63        if they are present, to  ship  given  data  to  a  printer
64        attached to the terminal.
65
66        Note  that  the <STRONG>mcprint</STRONG> code has no way to do flow control
67        with the printer or to know how  much  buffering  it  has.
68        Your  application  is  responsible for keeping the rate of
69        writes to the printer below its continuous throughput rate
70        (typically  about  half  of its nominal cps rating).  Dot-
71        matrix printers and 6-page-per-minute lasers can typically
72        handle  80cps,  so a good conservative rule of thumb is to
73        sleep for a second after shipping each 80-character  line.
74
75
76
77 </PRE>
78 <H2>RETURN VALUE</H2><PRE>
79        The  <STRONG>mcprint</STRONG>  function  returns <STRONG>ERR</STRONG> if the write operation
80        aborted for some reason.  In this case, errno will contain
81        either  an  error  associated  with <STRONG>write(2)</STRONG> or one of the
82        following:
83
84        ENODEV
85             Capabilities for printer redirection don't exist.
86
87        ENOMEM
88             Couldn't allocate sufficient  memory  to  buffer  the
89             printer write.
90
91             When <STRONG>mcprint</STRONG> succeeds, it returns the number of char-
92             acters actually sent to the printer.
93
94
95 </PRE>
96 <H2>PORTABILITY</H2><PRE>
97        The <STRONG>mcprint</STRONG> call was designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and is  not
98        found in SVr4 curses, 4.4BSD curses, or any other previous
99        version of curses.
100
101
102 </PRE>
103 <H2>BUGS</H2><PRE>
104        Padding in the <STRONG>mc5p</STRONG>, <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities will not  be
105        interpreted.
106
107
108 </PRE>
109 <H2>SEE ALSO</H2><PRE>
110        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
111
112
113
114                                                    <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
115 </PRE>
116 <HR>
117 <ADDRESS>
118 Man(1) output converted with
119 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
120 </ADDRESS>
121 </BODY>
122 </HTML>