summaryrefslogtreecommitdiff
path: root/tcl/doc/ChnlStack.3
diff options
context:
space:
mode:
Diffstat (limited to 'tcl/doc/ChnlStack.3')
-rw-r--r--tcl/doc/ChnlStack.311
1 files changed, 10 insertions, 1 deletions
diff --git a/tcl/doc/ChnlStack.3 b/tcl/doc/ChnlStack.3
index a99e2848e69..c1c3c87ebf4 100644
--- a/tcl/doc/ChnlStack.3
+++ b/tcl/doc/ChnlStack.3
@@ -10,7 +10,7 @@
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel \- stack an I/O channel on top of another, and undo it
+Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel, Tcl_GetTopChannel \- stack an I/O channel on top of another, and undo it
.SH SYNOPSIS
.nf
.nf
@@ -25,6 +25,9 @@ int
Tcl_Channel
\fBTcl_GetStackedChannel\fR(\fIchannel\fR)
.sp
+Tcl_Channel
+\fBTcl_GetTopChannel\fR(\fIchannel\fR)
+.sp
.SH ARGUMENTS
.AS Tcl_ChannelType
.AP Tcl_Interp *interp in
@@ -82,6 +85,12 @@ associated with the channel name, and the processing module added by
\fBTcl_UnstackChannel\fP is equivalent to \fBTcl_Close\fP. If an error
occurs unstacking the channel, \fBTCL_ERROR\fR is returned, otherwise
\fBTCL_OK\fR is returned.
+.PP
+\fBTcl_GetTopChannel\fR returns the top channel in the stack of
+channels the supplied channel is part of.
+.PP
+\fBTcl_GetStackedChannel\fR returns the channel in the stack of
+channels which is just below the supplied channel.
.SH "SEE ALSO"
Notifier(3), Tcl_CreateChannel(3), Tcl_OpenFileChannel(3), vwait(n).