summaryrefslogtreecommitdiffstats
path: root/doc/FileSystem.3
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-11-13 08:58:49 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-11-13 08:58:49 (GMT)
commit1fa28c73f4fb30900111ae304f4cec8165d20e22 (patch)
treea14fd53ffaa35ecdbd1706eaef3664fe0a086881 /doc/FileSystem.3
parent1d0a01ece902a32167f162e2f98bd5071095f7df (diff)
parentd911ff5d3251cab6389f567c5db7d4def10f2c0b (diff)
downloadtcl-1fa28c73f4fb30900111ae304f4cec8165d20e22.zip
tcl-1fa28c73f4fb30900111ae304f4cec8165d20e22.tar.gz
tcl-1fa28c73f4fb30900111ae304f4cec8165d20e22.tar.bz2
Rebase to 9.0. Document the TCL_8_API flag.
Diffstat (limited to 'doc/FileSystem.3')
-rw-r--r--doc/FileSystem.311
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index 86a46c7..b8766e7 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -270,11 +270,12 @@ allowed for the \fImode\fR argument to the Tcl \fBopen\fR command.
POSIX-style permission flags such as 0644. If a new file is created, these
permissions will be set on the created file.
.AP "Tcl_Size \&| int" *lenPtr out
-Filled with the number of elements in the split path. May be (Tcl_Size *)NULL when not used. If it points to a variable which
-type is not \fBTcl_Size\fR, a compiler warning will be generated, in
-order to indicate that when number of elements is larger than INT_MAX
-this function will return NULL (which should trigger proper error-handling).
-Apart from that, it will function as expected.
+Filled with the number of elements in the split path.
+May be (Tcl_Size *)NULL when not used. If it points to a variable which
+type is not \fBTcl_Size\fR, a compiler warning will be generated.
+If your extensions is compiled with -DTCL_8_API, this function will return
+NULL if the number of elements is larger than INT_MAX (which should
+trigger proper error-handling), otherwise expect it to crash.
.AP Tcl_Obj *basePtr in
The base path on to which to join the given elements. May be NULL.
.AP Tcl_Size objc in