From f8d5b5a306792b916384368ee6ddb2d26cfc4a76 Mon Sep 17 00:00:00 2001 From: andreas_kupries Date: Wed, 5 Oct 2005 20:35:45 +0000 Subject: * doc/CrtChannel.3: Fixed [SF Tcl Bug 1104682], by application of David Welton's patch for it, and added a note about wideSeekProc. FossilOrigin-Name: 14d10f221342c699d5d06f87fd7fb4d6ab657608 --- ChangeLog | 6 ++++++ doc/CrtChannel.3 | 18 ++++++++++-------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index 5cc15b6..a056201 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2005-10-05 Andreas Kupries + + * doc/CrtChannel.3: Fixed [SF Tcl Bug 1104682], by application of + David Welton's patch for it, and added a note about + wideSeekProc. + 2005-10-05 Jeff Hobbs * tests/env.test (env-6.1): diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index ee5ea72..bd45c6c 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -5,7 +5,7 @@ '\" 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.16.2.4 2005/02/23 10:27:45 dkf Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.16.2.5 2005/10/05 20:35:45 andreas_kupries Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.4 Tcl "Tcl Library Procedures" .BS @@ -343,13 +343,15 @@ typedef struct Tcl_ChannelType { } Tcl_ChannelType; .CE .PP -The driver must provide implementations for all functions except -\fIblockModeProc\fR, \fIseekProc\fR, \fIsetOptionProc\fR, -\fIgetOptionProc\fR, and \fIclose2Proc\fR, which may be specified as -NULL. Other functions that can not be implemented for this type of -device should return \fBEINVAL\fR when invoked to indicate that they -are not implemented, except in the case of \fIflushProc\fR and -\fIhandlerProc\fR, which should specified as NULL if not otherwise defined. +It is not necessary to provide implementations for all channel +operations. Those which are not necessary may be set to NULL in the +struct: \fIblockModeProc\fR, \fIseekProc\fR, \fIsetOptionProc\fR, +\fIgetOptionProc\fR, and \fIclose2Proc\fR, in addition to +\fIflushProc\fR, \fIhandlerProc\fR, and \fIthreadActionProc\fR. Other +functions that cannot be implemented in a meaningful way should return +\fBEINVAL\fR when called, to indicate that the operations they +represent are not available. Also note that \fIwideSeekProc\fR can be +NULL if \fIseekProc\fR is. .PP The user should only use the above structure for \fBTcl_ChannelType\fR instantiation. When referencing fields in a \fBTcl_ChannelType\fR -- cgit v0.12