diff options
Diffstat (limited to 'doc/GetOpnFl.3')
| -rw-r--r-- | doc/GetOpnFl.3 | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/GetOpnFl.3 b/doc/GetOpnFl.3 index 7524aeb..a450b02 100644 --- a/doc/GetOpnFl.3 +++ b/doc/GetOpnFl.3 @@ -3,10 +3,9 @@ '\" '\" 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.11 2005/05/10 18:33:56 kennykb Exp $ -.so man.macros +'\" .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures" +.so man.macros .BS .SH NAME Tcl_GetOpenFile \- Return a FILE* for a channel registered in the given interpreter (Unix only) @@ -27,7 +26,7 @@ String identifying channel, such as \fBstdin\fR or \fBfile4\fR. Non-zero means the file will be used for writing, zero means it will be used for reading. .AP int checkUsage in -If non-zero, then an error will be generated if the file wasn't opened +If non-zero, then an error will be generated if the file was not opened for the access indicated by \fIwrite\fR. .AP ClientData *filePtr out Points to word in which to store pointer to FILE structure for @@ -46,8 +45,8 @@ 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. \fIchanID\fR didn't -make any sense or \fIcheckUsage\fR was set and the file wasn't opened +If an error occurs in \fBTcl_GetOpenFile\fR (e.g. \fIchanID\fR did not +make any sense or \fIcheckUsage\fR was set and the file was not opened for the access specified by \fIwrite\fR) then \fBTCL_ERROR\fR is returned and the interpreter's result will contain an error message. In the current implementation \fIcheckUsage\fR is ignored and consistency |