diff options
Diffstat (limited to 'doc/GetOpnFl.3')
| -rw-r--r-- | doc/GetOpnFl.3 | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/GetOpnFl.3 b/doc/GetOpnFl.3 index 16c6262..5982460 100644 --- a/doc/GetOpnFl.3 +++ b/doc/GetOpnFl.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: GetOpnFl.3,v 1.9 2005/04/06 20:55:21 dkf Exp $ +'\" RCS: @(#) $Id: GetOpnFl.3,v 1.10 2005/05/03 18:07:42 dgp Exp $ .so man.macros .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -15,13 +15,13 @@ Tcl_GetOpenFile \- Return a FILE* for a channel registered in the given interpre \fB#include <tcl.h>\fR .sp int -\fBTcl_GetOpenFile\fR(\fIinterp, string, write, checkUsage, filePtr\fR) +\fBTcl_GetOpenFile\fR(\fIinterp, chanID, write, checkUsage, filePtr\fR) .sp .SH ARGUMENTS .AS Tcl_Interp checkUsage out .AP Tcl_Interp *interp in Tcl interpreter from which file handle is to be obtained. -.AP "const char" *string in +.AP "const char" *chanID in String identifying channel, such as \fBstdin\fR or \fBfile4\fR. .AP int write in Non-zero means the file will be used for writing, zero means it will @@ -31,7 +31,7 @@ If non-zero, then an error will be generated if the file wasn't opened for the access indicated by \fIwrite\fR. .AP ClientData *filePtr out Points to word in which to store pointer to FILE structure for -the file given by \fIstring\fR. +the file given by \fIchanID\fR. .BE .SH DESCRIPTION @@ -46,7 +46,7 @@ In some cases, such as a channel that connects to a pipeline of subprocesses, different FILE pointers will be returned for reading and writing. \fBTcl_GetOpenFile\fR normally returns \fBTCL_OK\fR. -If an error occurs in \fBTcl_GetOpenFile\fR (e.g. \fIstring\fR didn't +If an error occurs in \fBTcl_GetOpenFile\fR (e.g. \fIchanID\fR didn't make any sense or \fIcheckUsage\fR was set and the file wasn't opened for the access specified by \fIwrite\fR) then \fBTCL_ERROR\fR is returned and the interpreter's result will contain an error message. |