blob: 508f964dccafa9ed6f5fd5579c56a33e93e21c17 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +01003 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05304 * *
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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +010029 * @Id: curs_print.3x,v 1.10 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053030-->
Steve Kondikae271bc2015-11-15 02:50:53 +010031<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053032<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010034<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053036<TITLE>curs_print 3x</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +010041<H1 class="no-header">curs_print 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053042<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<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>
Steve Kondikae271bc2015-11-15 02:50:53 +010049<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053050 <STRONG>mcprint</STRONG> - ship binary data to printer
51
52
53</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010054<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053055 <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>
Steve Kondikae271bc2015-11-15 02:50:53 +010061<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053062 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
Steve Kondikae271bc2015-11-15 02:50:53 +010073 sleep for a second after shipping each 80-character line.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053074
75
76</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010077<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
78 The <STRONG>mcprint</STRONG> function returns <STRONG>ERR</STRONG> if the write operation
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053079 aborted for some reason. In this case, errno will contain
Steve Kondikae271bc2015-11-15 02:50:53 +010080 either an error associated with <STRONG>write(2)</STRONG> or one of the
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053081 following:
82
83 ENODEV
84 Capabilities for printer redirection do not exist.
85
86 ENOMEM
Steve Kondikae271bc2015-11-15 02:50:53 +010087 Couldn't allocate sufficient memory to buffer the
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053088 printer write.
89
90 When <STRONG>mcprint</STRONG> succeeds, it returns the number of characters
91 actually sent to the printer.
92
93
94</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010095<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
96 The <STRONG>mcprint</STRONG> call was designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and is not
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053097 found in SVr4 curses, 4.4BSD curses, or any other previous
98 version of curses.
99
100
101</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100102<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
103 Padding in the <STRONG>mc5p</STRONG>, <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities will not be
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530104 interpreted.
105
106
107</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100108<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530109 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
110
111
112
113 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
114</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100115<div class="nav">
116<ul>
117<li><a href="#h2-NAME">NAME</a></li>
118<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
119<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
120<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122<li><a href="#h2-BUGS">BUGS</a></li>
123<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124</ul>
125</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530126</BODY>
127</HTML>