Drives

Returns a collection of SFDrive objects - one for each drive on the system.

Syntax:

Set drvs = FS.Drives

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
Set drvs = FS.Drives
For Each drv In drvs
   MsgBox drv.DriveLetter & " - " & drv.FreeSpace & " bytes" & "<BR>"
Next 

Remarks:

The following properties are returned in the Drive object: DriveType, DriveLetter, FileSystem, FreeSpace, SerialNumber, TotalSize, VolumeName. On CE devices, only the main store is returned.

CreateDirectory

Create a new directory.

Syntax:

Set Dir = FS.CreateDirectory(path[, flags])

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
Set Dir = FS.CreateDirectory("C:\myDir)
          

Remarks:

Flags are:

• 0 - Fail if directory already exists (default)
• 4096 - If directory exists, delete and recreate.

CreateFile

Create a new file. Returns a File (SFStream) Object.

Syntax:

Set newFile = FS.CreateFile(path[, flags])

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
Set newFile = FS.CreateFile("C:\myDir\Temp.txt")
          

Remarks:

Flags are:

• 0 - Fail if file already exists (default)
• 4096 - If file exists, delete and recreate.

OpenDirectory

Open an existing Directory. Returns a Directory (SFStorage) Object.

Syntax:

Set Dir = FS.OpenDirectory(path[, flags])

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
Set Dir = FS.OpenDirectory"C:\myDir")
          

Remarks:

OpenFile

Open an existing file. Returns a File (SFStream) Object.

Syntax:

Set Dir = FS.OpenFile(path[, flags])

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
Set Dir = FS.OpenFile("C:\myDir\Temp.txt")
          

Remarks:

Flags are:

• 0 - Read Only (default)
• 1 - Write Only
• 2 - Read and Write
• 64 - Fully shared
• 48 - Read is forbidden for other apps
• 32 - Write if forbidden for other apps
• 16 - Other apps get an error if they try to open
• 18 - Exclusive and Read Write (default)

FileExists

Check if a file exists.

Syntax:

FileExists(path)

Examples:

If FS.FileExists("C:\myDir\Temp.txt") then MsgBox "File Exists"
          

Remarks:

Returns True if file exists.

FolderExists

Check if a folder exists.

Syntax:

FolderExists(path)

Examples:

If FS.FolderExists("C:\myDir") then MsgBox "Folder Exists"
          

Remarks:

Returns True if folder exists.

Exists

Check if a file or folder exists.

Syntax:

Exists(path)

Examples:

If FS.Exists("C:\myDir") then MsgBox "Folder or Folder Exists"
          

Remarks:

• 0 - Does not exist
• -1- folder exists
• 1 - file exists

DeleteFile

Delete an existing file.

Syntax:

FS.DeleteFile(path[, BoolForce])

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
FS.DeleteFile("C:\myDir\Temp.txt")
          

Remarks:

Set BoolForce to True to delete even if file is Read only. Default is false.

DeleteFolder

Delete an existing folder and all its contents, recursively.

Syntax:

FS.DeleteFolder(path[, BoolForce])

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
FS.DeleteFolder("C:\myDir")
          

Remarks:

Set BoolForce to True to delete even if Read only. Default is false.

CopyFile

Copies file (or files if wildcards are used) into the file system.

Syntax:

FS.CopyFile( source, destination [, fReplace = True])

Parameters:

source - Source file full path name or path with wildcards.

destination - Destination full path name of a file or directory. No wildcards are allowed in this parameter. If wildcards are used in the source parameter the destination should be a directory.

fReplace - Optional Boolean flag. The default value is True. Indicates if file replace is allowed in the destination if a file with the same name already exists in that location.

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
FS.CopyFile("C:\Directory\*.txt","C:\MyTexts")
' Copy all the text files
FS.CopyFile("C:\a.txt","C:\b.txt")
' Copy a.txt into b.txt file

Remarks:

If fReplace is set to False the method will fail if a file with the same name exists in the destination location.

Using full path names for both source and the destination allows the application to copy the selected file under new file name.

If wildcards are used in the source and a full file path (not directory) is used in the destination parameter no error will occur but the source files matching the wildcards will be copied one by one over the same file and the last one will remain as result.

For copy/move operations across the different storage types see the members of SFStorage and SFStream objects.

If the parameters contain non-full path names (file names or relative paths) they are assumed relative to the current work directory as usual.

GetDrive

Extracts the drive name portion of the path

Syntax:

var = FS.GetDrive(path)

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
myDriveName = FS.GetDrive("C:\myDir\Temp.txt") 'result is "C:"
          

Remarks:

Returns a string containing the drive name portion from the path parameter. In case of mapped drive it will be C:, D: etc. In case of network path it will be something like \\server\share\. The method never fails. Instead an empty string will be returned if the path does not contain recognizable drive name portion.

The method supports mapped and windows networking paths (\\server\share\...).

This method performs only textual analysis - there is no guarantee that the returned value matches any existing drive on the system.

GetExtensionName

Extracts the extension name portion of the path

Syntax:

var = FS.GetExtensionName(path)

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
myExtensionName = FS.GetExtensionName("C:\myDir\Temp.txt") 'result is ".txt"
          

Remarks:

The file name extension is the portion of the file name after the last "." character in the last file or directory name in the path. The path parameter can be full path, relative path or file/directory name only. If no extension presents an empty string will be returned.

In most cases directories are named not using extensions in their names. However "name extension" term is applicable for them as well - and can be quite useful for certain applications.

GetFileName

Extracts the file name portion of the path

Syntax:

var = FS.GetFileName(path)

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
myExtensionName = FS.GetFileName("C:\myDir\Temp.txt") 'result is "Temp"
          

Remarks:

The method can be used to extract file or directory names as well. Its behavior for directories depends on the syntax used - if there is trailing "\" in the passed path specification the file/directory name is empty.

Note that the analysis performed is textual - the operation can be performed on existing and non-existing objects. This allows the method to be used in code intended to "plan" future file/directory creation tasks for example.

GetFilePath

Extracts the path name portion of the path

Syntax:

var = FS.GetFilePath(path)

Examples:

AddObject "newObjects.utilctls.SFMain", "FS"
myPathName = FS.GetFilePath("C:\myDir\Temp.txt") 'result is "C:\myDir"
          

Remarks:

The method can be used to extract file or directory names as well. Its behavior for directories depends on the syntax used - if there is trailing "\" in the passed path specification the file/directory name is empty.

Note that the analysis performed is textual - the operation can be performed on existing and non-existing objects. This allows the method to be used in code intended to "plan" future file/directory creation tasks for example.