File: get-output-stream-string.htm

package info (click to toggle)
nyquist 3.20%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 58,008 kB
  • sloc: ansic: 74,743; lisp: 17,929; java: 10,723; cpp: 6,690; sh: 171; xml: 58; makefile: 40; python: 15
file content (80 lines) | stat: -rw-r--r-- 2,770 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<html><head><title>XLISP get-output-stream-string</title>

<link rel="stylesheet" type="text/css" href="reference.css">

</head>

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

<hr>

<h1>get-output-stream-string</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>xlfio.c</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<dl>
<dt>(get-output-stream-string <i>stream</i>)</dt>
<dd><i>stream</i> - an output stream expression<br>
returns - the output so far as a string</dd>
</dl>

<h2>Description</h2>

<p>The 'get-output-stream-string' function empties the specified 'stream'
and returns this data as a single string. The output stream is emptied by
this operation.</p>

<h2>Examples</h2>

<pre class="example">
(setq out (make-string-output-stream))  <font color="#008844">; returns #&lt;Unnamed-Stream: #...&gt;</font>

(format out "fee fi fo fum ")           <font color="#008844">; \</font>
(format out "I smell the blood of ")    <font color="#008844">;  fill up output stream</font>
(format out "Elmer Fudd")               <font color="#008844">; /</font>
(get-output-stream-string out)          <font color="#008844">; returns "fee fi fo fum I smell the blood of Elmer Fudd"</font>

(format out "~%now what")               <font color="#008844">; add more to output stream</font>
(get-output-stream-string out)          <font color="#008844">; returns "\nnow what"</font>
(get-output-stream-string out)          <font color="#008844">; returns ""</font>

(format out "hello")                    <font color="#008844">; add more to output stream</font>
(read out)                              <font color="#008844">; returns HELLO</font>
</pre>

<p>See the
<a href="../manual/xlisp-man-030.htm#get-output-stream-string">get-output-stream-string</a>
function in the <nobr>XLISP 2.0</nobr> manual.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

</body></html>