(String Ports): In call-with-output-string, note proc
authorKevin Ryde <user42@zip.com.au>
Thu, 2 Oct 2003 00:20:07 +0000 (00:20 +0000)
committerKevin Ryde <user42@zip.com.au>
Thu, 2 Oct 2003 00:20:07 +0000 (00:20 +0000)
should not close the port.  In get-output-string, note string must be
gotten before closing the port.

doc/ref/scheme-io.texi

index 3dc1dd4..54688c0 100644 (file)
@@ -798,7 +798,7 @@ file port facilities:
 @deffnx {C Function} scm_call_with_output_string (proc)
 Calls the one-argument procedure @var{proc} with a newly created output
 port.  When the function returns, the string composed of the characters
-written into the port is returned.
+written into the port is returned.  @var{proc} should not close the port.
 @end deffn
 
 @deffn {Scheme Procedure} call-with-input-string string proc
@@ -842,6 +842,9 @@ inaccessible.
 Given an output port created by @code{open-output-string},
 return a string consisting of the characters that have been
 output to the port so far.
+
+@code{get-output-string} must be used before closing @var{port}, once
+closed the string cannot be obtained.
 @end deffn
 
 A string port can be used in many procedures which accept a port