summaryrefslogtreecommitdiff
path: root/doc/ref/scheme-io.texi
diff options
context:
space:
mode:
authorKevin Ryde <user42@zip.com.au>2003-10-02 00:20:07 +0000
committerKevin Ryde <user42@zip.com.au>2003-10-02 00:20:07 +0000
commit0853a58069d4a8e9e56b34108643e4780fe1e7f8 (patch)
tree3444e96fa82298614172b7a3fc26c15824b7efc4 /doc/ref/scheme-io.texi
parent39a963ee8109d2c8d116e06a05155d3e68cbb755 (diff)
downloadguile-0853a58069d4a8e9e56b34108643e4780fe1e7f8.tar.gz
(String Ports): In call-with-output-string, note proc
should not close the port. In get-output-string, note string must be gotten before closing the port.
Diffstat (limited to 'doc/ref/scheme-io.texi')
-rw-r--r--doc/ref/scheme-io.texi5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/ref/scheme-io.texi b/doc/ref/scheme-io.texi
index 3dc1dd4aa..54688c061 100644
--- a/doc/ref/scheme-io.texi
+++ b/doc/ref/scheme-io.texi
@@ -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