FindFirstDirectory

FindFirstDirectory

Syntax

FindFirstDirectory([in] FolderName, [out] FolderNameVar);

Description

To retrieve the first folder in a specific folder. FindFirstDirectory is normally followed by FindNextDirectory which continue the search for subsequent file.

Parameters

       FolderName

               The folder name to be scanned.

       FolderNameVar

               The name of the variable to receive the return folder name.

Return

       1 = success

       0 = failed

       -1 = FSCommands cannot be found

Example

FSCommand("FindFirstDirectory", "C:\\Data,*,FolderNameVar");

This will scan folder C:\Data for all subfolders. The first folder found will be returned in _root.FolderNameVar variable upon completion of this FSCommand call.

You can use an escape character ~ (tilda) to insert a comma into a file path.