====== DirExists Function     ======


 
==== Description ====
 
Used to determine whether a specific directory exists within the operating system.

**NOTE**: This function is deprecated in OpenInsight 10.0 and above.  Please use the [[rti_os_dir|RTI_OS_DIR() function]] instead.
 
==== Syntax ====
 
retval = DirExists(path)
 
==== Parameters ====
 
The function has the following parameters:

^Parameter^Description^
|path|The full path of the directory being tested.|
||||

 
==== Returns ====
 
^Value^Meaning^
|-1|The path does not exist.|
|0|The path is valid however it is not a directory.|
|1|The path exists.|

 
==== Example ====
 
<code>
* Determine if c:\temp exists

 

declare function DirExists

declare subroutine Msg

path = "C:\TEMP"

retval = DirExists(path)

 

begin case

   case retval = 0

     msg(@window,'The path ':path:' exists but is not a directory.')

   case retval = 1

     msg(@window,'The directory ':path:' does exist.')

   case retval = -1

     msg(@window,'The directory ':path:' does not exist.')

end case
</code>