RTI_OS_Directory function

This function provides methods for manipulating operating system directories. NOTE: This function should not be used in OpenInsight 10.x and above; instead, please use the replacement RTI_OS_DIR function.

retVal = RTI_OS_Directory( method, directory, <param1>, <param2>, <param3> )

The function has the following parameters:

Method dependent return value. All boolean return values are TRUE if successful and FALSE is unsuccessful.

When returning directories, the program does NOT append a trailing backslash (\).

DIR function, Drive function, InitDir statement, SetInitDirListOptions routine

Creates a new directory.

successful = RTI_OS_Directory( "CREATE", directory <, createPath> )

directory: The directory path to be created.

createPath: <Optional> A boolean value. If set to TRUE a multiple levels may be created.

A boolean value.

***************************************

declare function RTI_OS_Directory

 

// Create a new directory called mydir in c:\revsoft.

directory = "c:\revsoft\mydir"

result = RTI_OS_Directory( "CREATE", directory)

Example 2

***************************************

declare function RTI_OS_Directory

$Insert Logical 

// create the full directory structure c:\revsoft\newdir\mydir

declare function rti_os_directory

directory = "c:\revsoft\newdir\mydir"

createPath = TRUE$

result = RTI_OS_Directory( "CREATE", directory, createPath)

Deletes a directory if it is empty, and/or all the files in the directory.

success = RTI_OS_Directory( "DELETE", directory <, files> <, deleteDir> )

directory: The directory path to be deleted.

files: <Optional> The file(s) to be deleted.

If null and the directory is empty then the directory itself will be deleted.

Multiple filenames should be @fm-delimited, @vm-delimited or comma-delimited. This method does support the question mark (?) and asterisk (*) wildcards.

To delete all .doc files in a directory pass *.doc

deleteDir <Optional> If TRUE, will delete the directory after all the files are deleted.

The default value is FALSE.

A boolean value.

A directory will only be deleted if it is empty.

Example 1

declare function RTI_OS_Directory

// delete a directory called mydir in c:\revsoft.

directory = "c:\revsoft\mydir"

success = RTI_OS_Directory( "DELETE", directory)

Example 2

declare function RTI_OS_Directory

// delete all files in the directory c:\revsoft\mydir, but do not delete the directory

directory = "c:\revsoft\mydir"

files = "*.*"

success = RTI_OS_Directory( "DELETE", directory, files )

Example 3

declare function RTI_OS_Directory

$Insert Logical

// delete all files in the directory c:\revsoft\mydir and delete the directory

directory = "c:\revsoft\mydir"

files = "*.*"

success = RTI_OS_Directory( "DELETE", directory, files, TRUE$)

Renames a directory.

successful = RTI_OS_Directory( "RENAME", directory, newPath )

directory: The full path to the directory to rename.

newPath: The full path to the new name of the directory.

A boolean value. If FALSE, the use of Get_Status() will return an error code and description.

This method will only act upon on the lowest level directory.

Example 1

declare function RTI_OS_Directory

// Rename a directory called c:\revsoft\mydir to c:\revsoft\newdir

directory = "c:\revsoft\mydir"

newname = "c:\revsoft\newdir"

successful = RTI_OS_directory( "RENAME", directory, newname )

if not(successful) then

   error = Get_Status(errCodes)

   if error then

      call FsMsg()

   end

end

Determines whether a directory exists.

exists = RTI_OS_Directory( "EXISTS", directory )

directory: The full path to the directory to be verified.

-1: The path does not exist. 0: The path is valid however it is not a directory. 1: The path exists.

Example 1

declare function RTI_OS_Directory

// checks to see if the directory c:\revsoft\mydir exists

directory = "c:\revsoft\mydir"

exists = RTI_OS_Directory( "EXISTS", directory )

Calls the Common Windows File dialog window, modifying the dialog to display and return only directory information.

directory = RTI_OS_Directory( "CHOOSE" <, directory> <, title> )

directory: <Optional> The initial directory to be displayed.

title: <Optional> The title to display in the dialog window.

The full path to the directory chosen.

Example 1

declare function RTI_OS_Directory

// displays the choose directory dialog window with the initial directory set to c:\revsoft
// and with the text "Choose a directory" displayed in the dialog window

directory = "c:\revsoft"

title = "Choose a directory"

result = RTI_OS_Directory( "CHOOSE", directory, title)

Retrieves a list of the logical drives attached to the current machine.

results = RTI_OS_Directory( "GetLogicalDrives" )

<empty>: This method does not accept parameters.

An @fm-delimited list of logical drive letters.

Example 1

declare function RTI_OS_Directory

// returns a list of logical drives for the current machine

result = RTI_OS_Directory( "GETLOGICALDRIVES" )

Retrieves the subdirectories within a directory.

results = RTI_OS_Directory( "GETSUBDIRECTORIES" <, levels> )

directory: The directory from which subdirectories should be returned.

levels: <Optional> The number of subdirectory levels to navigate. Defaults to 1, which will only return the sub directories of the passed directory.

Returns an @fm delimited list of subdirectories in the given directory, in the order in which they were encountered.

Example 1

declare function RTI_OS_Directory

// returns an @fm delimited list of subdirectories in the c:\revsoft

// directory
 

directory = "c:\revsoft"

levels = 1

result = RTI_OS_Directory( "GETSUBDIRECTORIES", directory, levels )

Retrieves file names from a specified directory.

fileList = RTI_OS_Directory( "GetFiles", directory <,file_filter> <, attrib_filter> )

directory: The directory from which to retrieve the file list.

name_filter: <Optional> Filename filter. Supports the the use of wild cards ? and *.

attrib_filter: <Optional> File attributes filter. Refer to SetInitDirOptions subroutine for more information.

An @fm-delimited list of file names (not including the directory).

Example 1

declare function RTI_OS_Directory

// returns an @fm delimited list of files in the specified directory

directory = "c:\revsoft"

files = RTI_OS_Directory( "GETFILES", directory)

Example 2

declare function RTI_OS_Directory

// returns an @fm delimited list of files in the specified directory matching the filename

// filter.

// In this example files matching the file extension .pdf will be returned.

directory = "c:\revsoft\oinsight"

filter = "*.pdf"

result = RTI_OS_Directory( "GETFILES", directory, filter )

Example 3

declare function RTI_OS_Directory

// returns an @fm delimited list of files in the specified directory matching the filename

// filter and the special attributes filter.

// In this example a list of files with a .pdf extension which have the archive attribute will

// be returned.

directory = "c:\revsoft"

filter = "*.pdf"

attributes = "A"

result = RTI_OS_Directory( "GETFILES", directory, filter, attributes )

Returns the requested attributes of a file. Attributes include size, create date, create time and extended attributes like image details and mp3 encoding details.

attribs = RTI_OS_Directory( "GetAttributes", directory, filename <, attributes> )

directory: The directory path containing the file whose attributes are to be returned.

filename: The name of the file whose attributes are to be returned.

attributes: <Optional> An @fm or @vm-delimited list of attributes to be returned. If null, then the function will return all attributes.

An @fm-delimited list of attribute values based on the order passed in the <attributes> parameter.

Example 1

declare function RTI_OS_Directory

// returns an @fm delimited list of all the extended attributes for a file

directory = "c:\revsoft\oinsight"

filename = "readme.pdf"

result = rti_os_directory( "GetAttributes", directory, filename)

Example 2

declare function RTI_OS_Directory


// returns the size of the file requested

directory = "c:\revsoft\oinsight"

filename = "readme.pdf"

attributes = "size"

result = RTI_OS_Directory( "GetAttributes", directory, filename, attributes )

Example 3

declare function RTI_OS_Directory

// returns an @fm delimited list of attributes in the order in which they are requested

directory = "c:\revsoft\oinsight"

filename = "readme.pdf"

attributes = "size,kind,title"

result = RTI_OS_Directory( "GetAttributes", directory, filter, attributes)

Returns the path to where Windows is installed.

results = RTI_OS_Directory( "GetWindowsDirectory" )

<empty>: This method does not accept parameters.

The full path to the directory where Windows is installed.

Example 1

declare function RTI_OS_Directory

// returns the path to the directory where windows is installed

result = RTI_OS_Directory( "GetWindowsDirectory")

Returns the path to where OpenInsight is installed.

result = RTI_OS_Directory( "GetOIDirectory" )

<empty>: This method does not accept parameters.

The full path to the directory where OpenInsight is installed.

Example 1

declare function RTI_OS_Directory

$Insert Logical

// returns the path to the directory where OpenInsight is installed

result = RTI_OS_Directory( "GetOIDirectory" )

Returns the path to the "My Documents" directory.

result = RTI_OS_Directory( "GetMyDocuments" )

<empty>

Returns the path to the "My Documents" directory.

Example 1

declare function RTI_OS_Directory

$Insert Logical

// returns the path to the the "My Documents" directory

result = RTI_OS_Directory( "GetMyDocuments" )

Returns the path to the Windows Desktop.

tempPath = RTI_OS_Directory( "GetDesktopDirectory" )

<empty>: This method does not accept parameters.

The full path to the directory where the Desktop is located.

Example 1

declare function RTI_OS_Directory

$Insert Logical

// returns the path to the directory where the Windows Temp folder is located

result = RTI_OS_Directory( "GetDesktopDirectory" )

Returns the path to the Windows temp directory.

tempPath = RTI_OS_Directory( "GetWindowsTempPath" )

<empty>: This method does not accept parameters.

The full path to the directory where the Windows TEMP folder is located.

Example 1

declare function RTI_OS_Directory

$Insert Logical

// returns the path to the directory where the Windows Temp folder is located

result = RTI_OS_Directory( "GetWindowsTempPath" )