64 lines
4.9 KiB
HTML
64 lines
4.9 KiB
HTML
<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>CLHS: Function GET-OUTPUT-STREAM-STRING</TITLE>
|
|
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
|
|
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
|
|
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
|
|
<LINK REL=TOP HREF="../Front/index.htm">
|
|
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
|
|
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
|
|
<LINK REL=PREV HREF="f_mk_con.htm">
|
|
<LINK REL=UP HREF="c_stream.htm">
|
|
<LINK REL=NEXT HREF="f_mk_s_1.htm">
|
|
</HEAD>
|
|
<BODY>
|
|
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="f_mk_con.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_stream.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_mk_s_1.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="get-output-stream-string"><I>Function</I> <B>GET-OUTPUT-STREAM-STRING</B></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>get-output-stream-string</B> <I>string-output-stream</I> => <I>string</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>string-output-stream</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#stream"><I>stream</I></A>. <P>
|
|
<I>string</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
Returns a <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A> containing, in order, all the <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> that have been output to <I>string-output-stream</I>. This operation clears any <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> on <I>string-output-stream</I>, so the <I>string</I> contains only those <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> which have been output since the last call to <A REL=DEFINITION HREF="#get-output-stream-string"><B>get-output-stream-string</B></A> or since the creation of the <I>string-output-stream</I>, whichever occurred most recently. <P>
|
|
<P><B>Examples:</B><P>
|
|
|
|
<PRE>
|
|
(setq a-stream (make-string-output-stream)
|
|
a-string "abcdefghijklm") => "abcdefghijklm"
|
|
(write-string a-string a-stream) => "abcdefghijklm"
|
|
(get-output-stream-string a-stream) => "abcdefghijklm"
|
|
(get-output-stream-string a-stream) => ""
|
|
</PRE>
|
|
</TT> <P>
|
|
<P><B>Side Effects:</B><P>
|
|
<P>
|
|
The <I>string-output-stream</I> is cleared. <P>
|
|
<P><B>Affected By:</B> None.
|
|
<P>
|
|
<P><B>Exceptional Situations:</B><P>
|
|
<P>
|
|
The consequences are undefined if <I>stream-output-string</I> is <A REL=DEFINITION HREF="26_glo_c.htm#closed"><I>closed</I></A>. <P>
|
|
The consequences are undefined if <I>string-output-stream</I> is a <A REL=DEFINITION HREF="26_glo_s.htm#stream"><I>stream</I></A> that was not produced by <A REL=DEFINITION HREF="f_mk_s_2.htm#make-string-output-stream"><B>make-string-output-stream</B></A>. The consequences are undefined if <I>string-output-stream</I> was created implicitly by <A REL=DEFINITION HREF="m_w_out_.htm#with-output-to-string"><B>with-output-to-string</B></A> or <A REL=DEFINITION HREF="f_format.htm#format"><B>format</B></A>. <P>
|
|
<P>
|
|
<P><B>See Also:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="f_mk_s_2.htm#make-string-output-stream"><B>make-string-output-stream</B></A> <P>
|
|
<P><B>Notes:</B> None.
|
|
<P>
|
|
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issues</A>, <I>not part of the specification</I>, apply to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss330.htm">STRING-OUTPUT-STREAM-BASHING:UNDEFINED</A><LI> <A REL=CHILD HREF="../Issues/iss052.htm">CLOSE-CONSTRUCTED-STREAM:ARGUMENT-STREAM-ONLY</A><P></UL><HR>
|
|
|
|
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
|
|
|
|
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
|
|
</BODY>
|
|
</HTML>
|