summaryrefslogtreecommitdiffstats
path: root/doc/FileSystem.3
diff options
context:
space:
mode:
authorvincentdarley <vincentdarley>2005-08-31 15:12:18 (GMT)
committervincentdarley <vincentdarley>2005-08-31 15:12:18 (GMT)
commit9dffb7863ba4b0e760ce19215def938abecbcfea (patch)
tree807c9aa089e7e4c4b5f9c102046d5b6780d24a19 /doc/FileSystem.3
parent2e73eedbe37a9f715cd90a7428f6d03648491e8a (diff)
downloadtcl-9dffb7863ba4b0e760ce19215def938abecbcfea.zip
tcl-9dffb7863ba4b0e760ce19215def938abecbcfea.tar.gz
tcl-9dffb7863ba4b0e760ce19215def938abecbcfea.tar.bz2
allow NULL interp in Tcl_FSMatchInDirectory
Diffstat (limited to 'doc/FileSystem.3')
-rw-r--r--doc/FileSystem.314
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index cdac36e..3aee462 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.54 2005/05/10 18:33:55 kennykb Exp $
+'\" RCS: @(#) $Id: FileSystem.3,v 1.55 2005/08/31 15:12:18 vincentdarley Exp $
'\"
.so man.macros
.TH Filesystem 3 8.4 Tcl "Tcl Library Procedures"
@@ -376,8 +376,9 @@ directory for all files which match a given pattern. The appropriate
function for the filesystem to which \fIpathPtr\fR belongs will be called.
.PP
The return value is a standard Tcl result indicating whether an error
-occurred in globbing. Error messages are placed in interp, but good
-results are placed in the resultPtr given.
+occurred in globbing. Error messages are placed in interp (unless
+interp is NULL, which is allowed), but good results are placed in the
+resultPtr given.
.PP
Note that the \fBglob\fR code implements recursive patterns internally, so
this function will only ever be passed simple patterns, which can be
@@ -1095,9 +1096,10 @@ not, so code should be flexible to both possibilities.
.PP
The return value is a standard Tcl result indicating whether an error
occurred in the matching process. Error messages are placed in
-\fIinterp\fR; on a \fBTCL_OK\fR result, results should be added to the
-\fIresultPtr\fR object given (which can be assumed to be a valid
-unshared Tcl list). The matches added
+\fIinterp\fR, unless \fIinterp\fR in NULL in which case no error
+message need be generated; on a \fBTCL_OK\fR result, results should be
+added to the \fIresultPtr\fR object given (which can be assumed to be a
+valid unshared Tcl list). The matches added
to \fIresultPtr\fR should include any path prefix given in \fIpathPtr\fR
(this usually means they will be absolute path specifications).
Note that if no matches are found, that simply leads to an empty