Name

---

      PathTo

Purpose

---

      Find a file in the $IDL_PATH search tree.

Category

---

      File System

Calling Sequence

---

      result = PathTo(file)

Inputs

---

      file: the name of a file to find.

Keywords

---

      verbose: set this to get some progress messages.

Outputs

---

      result: The complete path to file (including file) if found in
              the $IDL_PATH search tree or a null ('') string if not.

Side Effects

---

      This procedure uses FindFile to search the $IDL_PATH variable for
      file. The speed of this operation depends on the depth of the
      search and the operating system. The search stops when the
      file is found or all of $IDL_PATH has been searched. This could be a
      slow operation.

Example

---

    result = PathTo('mydata.dat')

Modification History

---

  Written by: Edward C. Wiebe, 2002-02-27.
      Modified: Edward C. Wiebe, 2002-03-05 (!path doesn't include
                      all directories. Switched to the expand_path
                      function)
      Modified: Edward C. Wiebe, 2002-03-06 (added searching
                      message (dots) and verbose keyword)