diff options
author | andreas_kupries <akupries@shaw.ca> | 2002-01-23 21:22:06 (GMT) |
---|---|---|
committer | andreas_kupries <akupries@shaw.ca> | 2002-01-23 21:22:06 (GMT) |
commit | 82914a2620307f81f9199eb2e9af70a11dc31ba4 (patch) | |
tree | f2a4df0bbc0cb75c7f5c374f9888f9df4a15ba96 /doc | |
parent | fe36337ab48292e97cc3cae11a8efe99c1143bde (diff) | |
download | tcl-82914a2620307f81f9199eb2e9af70a11dc31ba4.zip tcl-82914a2620307f81f9199eb2e9af70a11dc31ba4.tar.gz tcl-82914a2620307f81f9199eb2e9af70a11dc31ba4.tar.bz2 |
* unix/mkLinks: Regenerated.
* doc/CrtChannel.3:
* doc/ChnlStack.3: Moved documentation for 'Tcl_GetTopChannel'
from 'CrtChannel' to 'ChnlStack'. Added documentation of
'Tcl_GetStackedChannel'. Bug #506147 reported by Mark Patton
<msp@users.sourceforge.net>.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ChnlStack.3 | 13 | ||||
-rw-r--r-- | doc/CrtChannel.3 | 10 |
2 files changed, 13 insertions, 10 deletions
diff --git a/doc/ChnlStack.3 b/doc/ChnlStack.3 index e806510..0e8f9cd 100644 --- a/doc/ChnlStack.3 +++ b/doc/ChnlStack.3 @@ -4,13 +4,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ChnlStack.3,v 1.3 2000/09/28 06:34:56 hobbs Exp $ +'\" RCS: @(#) $Id: ChnlStack.3,v 1.4 2002/01/23 21:22:06 andreas_kupries Exp $ .so man.macros .TH Tcl_StackChannel 3 8.3 Tcl "Tcl Library Procedures" .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). diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 1f809bc..3273c6c 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -5,13 +5,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtChannel.3,v 1.13 2002/01/15 17:55:29 dgp Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.14 2002/01/23 21:22:06 andreas_kupries Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -Tcl_CreateChannel, Tcl_GetChannelInstanceData, Tcl_GetChannelType, Tcl_GetChannelName, Tcl_GetChannelHandle, Tcl_GetChannelMode, Tcl_GetChannelBufferSize, Tcl_SetChannelBufferSize, Tcl_NotifyChannel, Tcl_BadChannelOption, Tcl_ChannelName, Tcl_ChannelVersion, Tcl_ChannelBlockModeProc, Tcl_ChannelCloseProc, Tcl_ChannelClose2Proc, Tcl_ChannelInputProc, Tcl_ChannelOutputProc, Tcl_ChannelSeekProc, Tcl_ChannelSetOptionProc, Tcl_ChannelGetOptionProc, Tcl_ChannelWatchProc, Tcl_ChannelGetHandleProc, Tcl_ChannelFlushProc, Tcl_ChannelHandlerProc, Tcl_IsChannelShared, Tcl_IsChannelRegistered, Tcl_CutChannel, Tcl_SpliceChannel, Tcl_IsChannelExisting, Tcl_ClearChannelHandlers, Tcl_GetChannelThread, Tcl_ChannelBuffered, Tcl_GetTopChannel \- procedures for creating and manipulating channels +Tcl_CreateChannel, Tcl_GetChannelInstanceData, Tcl_GetChannelType, Tcl_GetChannelName, Tcl_GetChannelHandle, Tcl_GetChannelMode, Tcl_GetChannelBufferSize, Tcl_SetChannelBufferSize, Tcl_NotifyChannel, Tcl_BadChannelOption, Tcl_ChannelName, Tcl_ChannelVersion, Tcl_ChannelBlockModeProc, Tcl_ChannelCloseProc, Tcl_ChannelClose2Proc, Tcl_ChannelInputProc, Tcl_ChannelOutputProc, Tcl_ChannelSeekProc, Tcl_ChannelSetOptionProc, Tcl_ChannelGetOptionProc, Tcl_ChannelWatchProc, Tcl_ChannelGetHandleProc, Tcl_ChannelFlushProc, Tcl_ChannelHandlerProc, Tcl_IsChannelShared, Tcl_IsChannelRegistered, Tcl_CutChannel, Tcl_SpliceChannel, Tcl_IsChannelExisting, Tcl_ClearChannelHandlers, Tcl_GetChannelThread, Tcl_ChannelBuffered \- procedures for creating and manipulating channels .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -70,9 +70,6 @@ void int \fBTcl_ChannelBuffered\fR(\fIchannel\fR) .sp -Tcl_Channel -\fBTcl_GetTopChannel\fR(\fIchannel\fR) -.sp CONST char * \fBTcl_ChannelName\fR(\fItypePtr\fR) .sp @@ -266,9 +263,6 @@ procs to generate a complete error message. .VE .PP .VS 8.3.2 -\fBTcl_GetTopChannel\fR returns the top channel in the stack of -channels the supplied channel is part of. -.PP \fBTcl_ChannelBuffered\fR returns the number of bytes of input currently buffered in the internal buffer (push back area) of the channel itself. It does not report about the data in the overall |