summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorandreas_kupries <akupries@shaw.ca>2004-07-16 22:22:13 (GMT)
committerandreas_kupries <akupries@shaw.ca>2004-07-16 22:22:13 (GMT)
commit554d0e544dd8f6c9678f730a8ebce9a517ad7813 (patch)
tree58550924ca7a61dd430bbcb5c8914ad27fdb4585
parent6f9be46dca324a11afaa829bda9fd4c6d777a1c3 (diff)
downloadtcl-554d0e544dd8f6c9678f730a8ebce9a517ad7813.zip
tcl-554d0e544dd8f6c9678f730a8ebce9a517ad7813.tar.gz
tcl-554d0e544dd8f6c9678f730a8ebce9a517ad7813.tar.bz2
* doc/OpenFileChnl.3: Added description of the behaviour of
Tcl_ReadChars when its 'charsToRead' argument is set to -1. Fixes [Tcl SF Bug 934511].
-rw-r--r--ChangeLog4
-rw-r--r--doc/OpenFileChnl.36
2 files changed, 9 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index 9cab49f..60876f5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2004-07-16 Andreas Kupries <andreask@activestate.com>
+ * doc/OpenFileChnl.3: Added description of the behaviour of
+ Tcl_ReadChars when its 'charsToRead' argument is set to
+ -1. Fixes [Tcl SF Bug 934511].
+
* doc/CrtCommand.3: Added note that the arguments given to the
command proc of a Tcl_CreateCommand are in utf8 since Tcl
8.1. Closing [Tcl SF Patch 414778].
diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3
index e54972f..dd65367 100644
--- a/doc/OpenFileChnl.3
+++ b/doc/OpenFileChnl.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.20.2.3 2004/05/17 09:22:11 dkf Exp $
+'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.20.2.4 2004/07/16 22:22:15 andreas_kupries Exp $
.so man.macros
.TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures"
.BS
@@ -435,6 +435,10 @@ that were stored in \fIreadObjPtr\fR. If an error occurs while reading, the
return value is \-1 and \fBTcl_ReadChars\fR records a POSIX error code that
can be retrieved with \fBTcl_GetErrno\fR.
.PP
+Setting \fIcharsToRead\fR to \fB-1\fR will cause the command to read
+all characters currently available (non-blocking) or everything until
+eof (blocking mode).
+.PP
The return value may be smaller than the value to read, indicating that less
data than requested was available. This is called a \fIshort read\fR. In
blocking mode, this can only happen on an end-of-file. In nonblocking mode,