summaryrefslogtreecommitdiffstats
path: root/doc/FileSystem.3
diff options
context:
space:
mode:
authorvincentdarley <vincentdarley>2003-06-23 10:45:54 (GMT)
committervincentdarley <vincentdarley>2003-06-23 10:45:54 (GMT)
commita577b700081eed8aa4df896f66e1091160a91623 (patch)
tree33c0f564d1767d2283a6b26dae10be2bb384f921 /doc/FileSystem.3
parente42bd5945d15a3616dc2412e70037724fbe20e37 (diff)
downloadtcl-a577b700081eed8aa4df896f66e1091160a91623.zip
tcl-a577b700081eed8aa4df896f66e1091160a91623.tar.gz
tcl-a577b700081eed8aa4df896f66e1091160a91623.tar.bz2
fs documentation
Diffstat (limited to 'doc/FileSystem.3')
-rw-r--r--doc/FileSystem.326
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index dcb92b0..0853ccc 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.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: FileSystem.3,v 1.32 2003/02/10 12:50:31 vincentdarley Exp $
+'\" RCS: @(#) $Id: FileSystem.3,v 1.33 2003/06/23 10:45:54 vincentdarley Exp $
'\"
.so man.macros
.TH Filesystem 3 8.4 Tcl "Tcl Library Procedures"
@@ -779,18 +779,18 @@ representations.
.SH PATHINFILESYSTEMPROC
.PP
The \fIpathInFilesystemProc\fR field contains the address of a function
-which is called to determine whether a given path object belongs to
-this filesystem or not. Tcl will only call the rest of the filesystem
-functions with a path for which this function has returned
-\fBTCL_OK\fR. If the path does not belong, \fBTCL_ERROR\fR should be
-returned. If \fBTCL_OK\fR is returned, then the optional
-\fBclientDataPtr\fR output parameter can be used to return an internal
-(filesystem specific) representation of the path, which will be cached
-inside the path object, and may be retrieved efficiently by the other
-filesystem functions. Tcl will simultaneously cache the fact that this
-path belongs to this filesystem. Such caches are invalidated when
-filesystem structures are added or removed from Tcl's internal list of
-known filesystems.
+which is called to determine whether a given path object belongs to this
+filesystem or not. Tcl will only call the rest of the filesystem
+functions with a path for which this function has returned \fBTCL_OK\fR.
+If the path does not belong, -1 should be returned (the behaviour of Tcl
+for any other return value is not defined). If \fBTCL_OK\fR is returned,
+then the optional \fBclientDataPtr\fR output parameter can be used to
+return an internal (filesystem specific) representation of the path,
+which will be cached inside the path object, and may be retrieved
+efficiently by the other filesystem functions. Tcl will simultaneously
+cache the fact that this path belongs to this filesystem. Such caches
+are invalidated when filesystem structures are added or removed from
+Tcl's internal list of known filesystems.
.PP
.CS
typedef int Tcl_FSPathInFilesystemProc(