summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorferrieux <ferrieux@users.sourceforge.net>2012-01-12 20:34:59 (GMT)
committerferrieux <ferrieux@users.sourceforge.net>2012-01-12 20:34:59 (GMT)
commit412344346e6346c1ddbf305f10a79b8af8447189 (patch)
tree811c76233b2c5e45c6ff8837c41e6f5da37a7639
parentf7f4a7a4b7cfdc27c9c08d91bb8cea6d571d1c1f (diff)
downloadtcl-412344346e6346c1ddbf305f10a79b8af8447189.zip
tcl-412344346e6346c1ddbf305f10a79b8af8447189.tar.gz
tcl-412344346e6346c1ddbf305f10a79b8af8447189.tar.bz2
[Bug 3472316] Document the destructive semantics of [fconfigure -error] on sockets.
-rw-r--r--doc/socket.n3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/socket.n b/doc/socket.n
index bd307b7..c020839 100644
--- a/doc/socket.n
+++ b/doc/socket.n
@@ -136,6 +136,9 @@ This option gets the current error status of the given socket. This
is useful when you need to determine if an asynchronous connect
operation succeeded. If there was an error, the error message is
returned. If there was no error, an empty string is returned.
+
+Note that the error status is reset by the read operation; this mimics
+the underlying getsockopt(SO_ERROR) call.
.TP
\fB\-sockname\fR
This option returns a list of three elements, the address, the host name