TclSplitPath(3) Tcl Library Procedures TclSplitPath(3)

NAME
       TclSplitPath,  TclJoinPath,  TclGetPathType  -  manipulate platform-
       dependent file paths

SYNOPSIS
       ##iinncclluuddee <>

       TTccllSSpplliittPPaatthh(path, argcPtr, argvPtr)

       char *
       TTccllJJooiinnPPaatthh(argc, argv, resultPtr)

       TclPathType
       TTccllGGeettPPaatthhTTyyppee(path)

AARRGGUUMMEENNTTSS
       CONST char * CONST         *argvPtr(in)
                                            File path in  a  form  appropriate
                                            for  the current platform (see the
                                            ffiilleennaammee manual entry for  accept-
                                            able forms for path names).

       int           *argcPtr     (out)     Filled in with number of path ele-
                                            ments in path.

       CONST char    ***argvPtr   (out)     *argvPtr will be  filled  in  with
                                            the  address of an array of point-
                                            ers to the strings  that  are  the
                                            extracted elements of path.  There
                                            will be *argcPtr valid entries  in
                                            the  array,  followed  by  a  NULL
                                            entry.

       int           argc         (in)      Number of elements in argv.

       CONST char * CONST         *argv(in) Array of path  elements  to  merge
                                            together into a single path.

       TclDString   *resultPtr   (in/out)  A   pointer   to   an  initialized
                                            TTccllDDSSttrriinngg to which the result of
                                            TTccllJJooiinnPPaatthh will be appended.



DESCRIPTION
       These  procedures have been superceded by the objectified procedures in
       the FFiilleeSSyysstteemm man page, which are more efficient.

       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 ffiillee sspplliitt, ffiillee jjooiinn, and ffiillee ppaatthhttyyppee com-
       mands.

       TTccllSSpplliittPPaatthh breaks a path into its constituent elements, returning an
       array of pointers to the elements using argcPtr and argvPtr.  The  area
       of  memory pointed to by *argvPtr is dynamically allocated; in addition
       to the array of pointers, it also holds copies of  all  the  path  ele-
       ments.   It is the caller's responsibility to free all of this storage.
       For example, suppose that you have called TTccllSSpplliittPPaatthh with  the  fol-
       lowing code:
              int argc;
              char *path;
              char **argv;
              ...
              TclSplitPath(string, &argc, &argv);
       Then  you  should eventually free the storage with a call like the fol-
       lowing:
              TclFree((char *) argv);

       TTccllJJooiinnPPaatthh is the inverse of TTccllSSpplliittPPaatthh: it takes a collection  of
       path elements given by argc and argv and generates a result string that
       is a properly constructed  path.  The  result  string  is  appended  to
       resultPtr.  ResultPtr must refer to an initialized TTccllDDSSttrriinngg.

       If  the  result  of TTccllSSpplliittPPaatthh is passed to TTccllJJooiinnPPaatthh, the result
       will refer to the same location, but may not be in the same form.  This
       is because TTccllSSpplliittPPaatthh and TTccllJJooiinnPPaatthh eliminate duplicate path sep-
       arators and return a normalized form for each platform.

       TTccllGGeettPPaatthhTTyyppee  returns  the  type  of  the  specified   path,   where
       TTccllPPaatthhTTyyppee   is   one  of  TTCCLLPPAATTHHAABBSSOOLLUUTTEE,  TTCCLLPPAATTHHRREELLAATTIIVVEE,  or
       TTCCLLPPAATTHHVVOOLLUUMMEERREELLAATTIIVVEE.  See the ffiilleennaammee manual entry for a descrip-
       tion of the path types for each platform.


KKEEYYWWOORRDDSS
       file, filename, join, path, split, type



Tcl                                   7.5                     TclSplitPath(3)