diff options
Diffstat (limited to 'doc/SplitPath.3')
| -rw-r--r-- | doc/SplitPath.3 | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/SplitPath.3 b/doc/SplitPath.3 index b112b82..19cee05 100644 --- a/doc/SplitPath.3 +++ b/doc/SplitPath.3 @@ -4,10 +4,8 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SplitPath.3,v 1.2 1998/09/14 18:39:50 stanton Exp $ -'\" -.so man.macros .TH Tcl_SplitPath 3 7.5 Tcl "Tcl Library Procedures" +.so man.macros .BS .SH NAME Tcl_SplitPath, Tcl_JoinPath, Tcl_GetPathType \- manipulate platform-dependent file paths @@ -23,20 +21,20 @@ char * Tcl_PathType \fBTcl_GetPathType\fR(\fIpath\fR) .SH ARGUMENTS -.AS Tcl_DString ***argvPtr -.AP char *path in +.AS "const char *const" ***argvPtr in/out +.AP "const char" *path in File path in a form appropriate for the current platform (see the \fBfilename\fR manual entry for acceptable forms for path names). .AP int *argcPtr out Filled in with number of path elements in \fIpath\fR. -.AP char ***argvPtr out +.AP "const char" ***argvPtr out \fI*argvPtr\fR will be filled in with the address of an array of pointers to the strings that are the extracted elements of \fIpath\fR. There will be \fI*argcPtr\fR valid entries in the array, followed by a NULL entry. .AP int argc in Number of elements in \fIargv\fR. -.AP char **argv in +.AP "const char *const" *argv in Array of path elements to merge together into a single path. .AP Tcl_DString *resultPtr in/out A pointer to an initialized \fBTcl_DString\fR to which the result of @@ -45,6 +43,9 @@ A pointer to an initialized \fBTcl_DString\fR to which the result of .SH DESCRIPTION .PP +These procedures have been superseded by the Tcl-value-aware procedures in +the \fBFileSystem\fR man page, which are more efficient. +.PP These procedures may be used to disassemble and reassemble file paths in a platform independent manner: they provide C-level access to the same functionality as the \fBfile split\fR, \fBfile join\fR, and @@ -58,6 +59,7 @@ holds copies of all the path elements. It is the caller's responsibility to free all of this storage. For example, suppose that you have called \fBTcl_SplitPath\fR with the following code: +.PP .CS int argc; char *path; @@ -65,8 +67,10 @@ char **argv; \&... Tcl_SplitPath(string, &argc, &argv); .CE +.PP Then you should eventually free the storage with a call like the following: +.PP .CS Tcl_Free((char *) argv); .CE |