diff options
Diffstat (limited to 'doc/Access.3')
| -rw-r--r-- | doc/Access.3 | 37 |
1 files changed, 22 insertions, 15 deletions
diff --git a/doc/Access.3 b/doc/Access.3 index a561e3e..bdbbea3 100644 --- a/doc/Access.3 +++ b/doc/Access.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: Access.3,v 1.1 1999/04/17 01:36:32 hershey Exp $ +'\" RCS: @(#) $Id: Access.3,v 1.2 1999/04/30 22:45:00 stanton Exp $ '\" .so man.macros .TH Tcl_Access 3 8.1 Tcl "Tcl Library Procedures" @@ -16,20 +16,20 @@ Tcl_Access, Tcl_Stat \- check file permissions and other attributes \fB#include <tcl.h>\fR .sp int -\fBTcl_Access\fR(\fpath\fR, \fImode\fR) +\fBTcl_Access\fR(\fIpath\fR, \fImode\fR) .sp int -\fBTcl_Stat\fR(\fIpath\fR, \fIbufPtr\fR) +\fBTcl_Stat\fR(\fIpath\fR, \fIstatPtr\fR) .SH ARGUMENTS -.AS struct stat *bufPtr -.AP CONST char *path in +.AS stat *statPtr in +.AP char *path in Native name of the file to check the attributes of. .AP int mode in Mask consisting of one or more of R_OK, W_OK, X_OK and F_OK. R_OK, W_OK and X_OK request checking whether the file exists and has read, write and execute permissions, respectively. F_OK just requests checking for the existence of the file. -.AP struct stat *bufPtr out +.AP stat *statPtr out The structure that contains the result. .BE @@ -40,10 +40,8 @@ rather than calling system level functions \fBaccess\fR and \fBstat\fR directly. First, the Windows implementation of both functions fixes some bugs in the system level calls. Second, both \fBTcl_Access\fR and \fBTcl_Stat\fR (as well as \fBTcl_OpenFileChannelProc\fR) hook -into a linked list of functions, the first of which checks for the -existence of \fBpath\fR in a Zip file rather than on disc. The -hooking behavior is necessary for applications wrapped with TclPro -Wrapper. +into a linked list of functions. This allows the possibity to reroute +file access to alternative media or access methods. .PP \fBTcl_Access\fR checks whether the process would be allowed to read, write or test for existence of the file (or other file system object) @@ -55,10 +53,19 @@ On success (all requested permissions granted), zero is returned. On error (at least one bit in mode asked for a permission that is denied, or some other error occurred), -1 is returned. .PP -\fBTcl_Stat\fR returns the stat structure with information about the -specified file. You do not need any access rights to the file to get -this information but you need search rights to all directories named -in the path leading to the file. +\fBTcl_Stat\fR fills the stat structure \fIstatPtr\fR with information +about the specified file. You do not need any access rights to the +file to get this information but you need search rights to all +directories named in the path leading to the file. The stat structure +includes info regarding device, inode (always 0 on Windows), +priviledge mode, nlink (always 1 on Windows), user id (always 0 on +Windows), group id (always 0 on Windows), rdev (same as device on +Windows), size, last access time, last modification time, and creation +time. +.PP +If \fIpath\fR exists, \fBTcl_Stat\fR returns 0 and the stat structure +is filled with data. Otherwise, -1 is returned, and no stat info is +given. .SH KEYWORDS -statc access +stat access |