About Us Documentation

Contact Site Map




Tcl_GetOpenFile(3)   Tcl Library Procedures                   8.0



Tcl_GetOpenFile - Get a standard IO File * handle from a channel. (Unix only)


#include <tcl.h> int Tcl_GetOpenFile(interp, string, write, checkUsage, filePtr)


Tcl_Interp *interp (in) Tcl interpreter from which file handle is to be obtained. char *string (in) String identifying chan- nel, such as stdin or file4. int write (in) Non-zero means the file will be used for writ- ing, zero means it will be used for reading. int checkUsage (in) If non-zero, then an error will be generated if the file wasn't opened for the access indicated by write. ClientData *filePtr (out) Points to word in which to store pointer to FILE structure for the file given by string. _________________________________________________________________


Tcl_GetOpenFile takes as argument a file identifier of the form returned by the open command and returns at *filePtr a pointer to the FILE structure for the file. The write argu- ment indicates whether the FILE pointer will be used for reading or writing. In some cases, such as a channel that connects to a pipeline of subprocesses, different FILE pointers will be returned for reading and writing. Tcl_GetOpenFile normally returns TCL_OK. If an error occurs in Tcl_GetOpenFile (e.g. string didn't make any sense or checkUsage was set and the file wasn't opened for the access specified by write) then TCL_ERROR is returned and interp- Tcl 1 Tcl_GetOpenFile(3) Tcl Library Procedures 8.0 >result will contain an error message. In the current implementation checkUsage is ignored and consistency checks are always performed. | Note that this interface is only supported on the Unix plat- | form.


channel, file handle, permissions, pipeline, read, write Tcl 2 Prepared by Ready-to-Run Software, Inc.


Email addresses listed on this site may  NOT be used for unsolicited commercial email.

Ready-to-Run Software, Inc Privacy Statement

Portions (c)Copyright, 1996-2005 by Ready-to-Run Software, Inc
(All rights reserved.)
212 Cedar Cove
Lansing, NY 14882
Phone: 607 533 UNIX (8649)
Fax: 607 533 4002

To return to the Ready-to-Run Software WinPak Table of contents please presshere