Debian Codegraph @

doc/html/man/curs_print.3x.html

raw
1 <!--
2 ****************************************************************************
3 * Copyright 2018-2024,2025 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.41 2025/02/15 18:42:34 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 2025-02-15 ncurses 6.6 Library calls</TITLE>
38 <link rel="author" href="mailto:[email protected]">
39
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_print 3x 2025-02-15 ncurses 6.6 Library calls</H1>
43 <PRE>
44 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
45
46
47 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
48 <STRONG>mcprint</STRONG> - write binary data to printer using <EM>terminfo</EM> capabilities
49
50
51 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
52 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
53
54 <STRONG>int</STRONG> <STRONG>mcprint(char</STRONG> <STRONG>*</STRONG> <EM>data</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>len</EM><STRONG>);</STRONG>
55
56
57 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
58 <STRONG>mcprint</STRONG>, an <EM>ncurses</EM> extension to the <EM>curses</EM> library, uses the
59 terminal's <STRONG>prtr_non</STRONG> (<STRONG>mc5p</STRONG>) or <STRONG>prtr_on</STRONG> (<STRONG>mc5</STRONG>) and <STRONG>prtr_off</STRONG> (<STRONG>mc4</STRONG>) media
60 copy capabilities, if defined, to send <EM>len</EM> bytes of the given string
61 <EM>data</EM> to a printer attached to the terminal.
62
63 <STRONG>mcprint</STRONG> has no means of flow control to the printer nor of knowing how
64 much buffering it has. Your application is responsible for keeping the
65 rate of writes to the printer below its continuous throughput rate,
66 typically about half of its nominal characters-per-second (cps) rating.
67 Dot-matrix printers and 6-page-per-minute laser printers can typically
68 handle 80 cps, so a conservative rule of thumb is to sleep for one
69 second after sending an 80-character line.
70
71
72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73 On success, <STRONG>mcprint</STRONG> returns the number of characters sent to the
74 printer.
75
76 <STRONG>mcprint</STRONG> returns <STRONG>ERR</STRONG> if the write operation fails for any reason. In
77 that event, <STRONG>errno</STRONG> contains either a value set by <STRONG>write(2)</STRONG>, or one of
78 the following.
79
80 <STRONG>ENODEV</STRONG>
81 The terminal lacks relevant media copy capabilities.
82
83 <STRONG>ENOMEM</STRONG>
84 <EM>ncurses</EM> could not allocate sufficient memory to buffer the write
85 operation.
86
87
88 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
89 <STRONG>mcprint</STRONG> is an <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> extension, and is not found in SVr4 <EM>curses</EM>,
90 4.4BSD <EM>curses</EM>, or any other previous <EM>curses</EM> implementation.
91
92
93 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
94 Applications employing this <EM>ncurses</EM> extension should condition its use
95 on the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
96
97
98 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
99 <EM>ncurses</EM> introduced <EM>mcprint</EM> prior to version 1.9.9g (1996).
100
101
102 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
103 Padding in the <STRONG>prtr_non</STRONG> (<STRONG>mc5p</STRONG>), <STRONG>prtr_on</STRONG> (<STRONG>mc5</STRONG>), and <STRONG>prtr_off</STRONG> (<STRONG>mc4</STRONG>)
104 capabilities is not interpreted.
105
106
107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
109
110 ncurses 6.6 2025-02-15 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>
111 </PRE>
112 <div class="nav">
113 <ul>
114 <li><a href="#h2-NAME">NAME</a></li>
115 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
116 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
117 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
118 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
119 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
120 <li><a href="#h2-HISTORY">HISTORY</a></li>
121 <li><a href="#h2-BUGS">BUGS</a></li>
122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123 </ul>
124 </div>
125 </BODY>
126 </HTML>