GetOpnFl.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:2k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1996-1997 Sun Microsystems, Inc.
  3. '"
  4. '" See the file "license.terms" for information on usage and redistribution
  5. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  6. '" 
  7. '" RCS: @(#) $Id: GetOpnFl.3,v 1.4 2002/01/23 20:46:01 dgp Exp $
  8. .so man.macros
  9. .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures"
  10. .BS
  11. .SH NAME
  12. Tcl_GetOpenFile - Get a standard IO File * handle from a channel. (Unix only)
  13. .SH SYNOPSIS
  14. .nf
  15. fB#include <tcl.h>fR
  16. .sp
  17. int
  18. fBTcl_GetOpenFilefR(fIinterp, string, write, checkUsage, filePtrfR)
  19. .sp
  20. .SH ARGUMENTS
  21. .AS Tcl_Interp checkUsage
  22. .AP Tcl_Interp *interp in
  23. Tcl interpreter from which file handle is to be obtained.
  24. .AP "CONST char" *string in
  25. String identifying channel, such as fBstdinfR or fBfile4fR.
  26. .AP int write in
  27. Non-zero means the file will be used for writing, zero means it will
  28. be used for reading.
  29. .AP int checkUsage in
  30. If non-zero, then an error will be generated if the file wasn't opened
  31. for the access indicated by fIwritefR.
  32. .AP ClientData *filePtr out
  33. Points to word in which to store pointer to FILE structure for
  34. the file given by fIstringfR.
  35. .BE
  36. .SH DESCRIPTION
  37. .PP
  38. fBTcl_GetOpenFilefR takes as argument a file identifier of the form
  39. returned by the fBopenfR command and
  40. returns at fI*filePtrfR a pointer to the FILE structure for
  41. the file.
  42. The fIwritefR argument indicates whether the FILE pointer will
  43. be used for reading or writing.
  44. In some cases, such as a channel that connects to a pipeline of
  45. subprocesses, different FILE pointers will be returned for reading
  46. and writing.
  47. fBTcl_GetOpenFilefR normally returns TCL_OK.
  48. If an error occurs in fBTcl_GetOpenFilefR (e.g. fIstringfR didn't
  49. make any sense or fIcheckUsagefR was set and the file wasn't opened
  50. for the access specified by fIwritefR) then TCL_ERROR is returned
  51. and the interpreter's result will contain an error message.
  52. In the current implementation fIcheckUsagefR is ignored and consistency
  53. checks are always performed.
  54. .VS
  55. .PP
  56. Note that this interface is only supported on the Unix platform.
  57. .VE
  58. .SH KEYWORDS
  59. channel, file handle, permissions, pipeline, read, write