CodeHelperCollection - GFileSystem

VB Extension Tools HTML project report
Project: CodeHelperCollection	Module: GFileSystem

Basic information:

Module Type	Class module
File	C:\Code\EE-projects\units\vb\ActiveX\CodeHelperCollection\src\GFileSystem.cls
Author	Ralf Kunsmann
Date	2001 09 27
Purpose	Make all methodes of MFileSystem public. In other words: just delegate all methode calls to the corresponding methode of MFileSystem. The only special job in some procedures is to ensure object variables are expected types.
Requierements	MFileSystem.bas

Procedures:

	Class_Initialize
	FormatDrive
	SelectFolder
	SelectFolderEx
	SelectFile
	ExistFile
	FileAnyDateTime
	Win32ToVbTime
	GetFullPath
	GetFileBase
	GetFileBaseExt
	GetFileExt
	GetFileDir
	GetFileDirBase
	GetFileDisk
	GetFileFullSpec
	CopyAnyFile
	MoveAnyFile
	VBGetWindowsDirectory
	VBGetSystemDirectory
	NormalizePath
	DeNormalizePath
	PathExists
	FileToArray
	VBGetDiskFreeSpace
	EnsureFileIsWriteable
	CreateFolderStructure
	DeleteAnyFile
	GetSystemDirectory
	GetFileSize
	FileBackup
	StringArrayToFile
	StringToFile
	GetFiles
	PathAccessRights

Procedure 'Class_Initialize'

List of procedures

Scope/Type	Private Sub

Procedure 'FormatDrive'

List of procedures

Scope/Type	Public Sub
Code parameters	DriveLetter As String Owner As Object
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Format a Drive.

Procedure 'SelectFolder'

List of procedures

Scope/Type	Public Function
Code parameters	StartFolderID As Long UserMsg As String Owner As Object
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Display the default Windows dialog for folder selection.

Procedure 'SelectFolderEx'

List of procedures

Scope/Type	Public Function
Code parameters	StartFolderID As Long UserMsg As String OwnerHWnd As Long Optional StartFolder As String = ""
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Display the default Windows dialog for folder selection with ability to specify start fodler.

Procedure 'SelectFile'

List of procedures

Scope/Type	Public Function
Code parameters	InitDir As String DialogTitle As String Optional Filter As String = "All Files
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Display Windows default dialog for file selection.

Procedure 'ExistFile'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Check whether the specified file exists (parameter is expected to contain full path).

Procedure 'FileAnyDateTime'

List of procedures

Scope/Type	Public Function
Code parameters	Path As String Optional datCreation As Date Optional datAccess As Date
Code return value	Date
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Get file time stamp (path is expected to contain full path).

Procedure 'Win32ToVbTime'

List of procedures

Scope/Type	Public Function
Code parameters	FileTime As Currency
Code return value	Date
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Convert a time stamp from Win 32 format to VB 'Date' format.

Procedure 'GetFullPath'

List of procedures

Scope/Type	Public Function
Code parameters	FileName As String Optional FilePart As Long Optional ExtPart As Long Optional DirPart As Long
Code return value	String

Procedure 'GetFileBase'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'GetFileBaseExt'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'GetFileExt'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'GetFileDir'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'GetFileDirBase'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'GetFileDisk'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'GetFileFullSpec'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	String

Procedure 'CopyAnyFile'

List of procedures

Scope/Type	Public Function
Code parameters	Source As String Destination As String Optional Options As Long = 0 Optional Owner As Long = hNull Optional ProgressTitle As String = ""
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Copy file using OS function (default dialog with progress bar).

Procedure 'MoveAnyFile'

List of procedures

Scope/Type	Public Function
Code parameters	Source As String Destination As String Optional Options As Long = 0 Optional Owner As Long = hNull Optional ProgressTitle As String = ""
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Move a file using OS function (default dialog with progress bar).

Procedure 'VBGetWindowsDirectory'

List of procedures

Scope/Type	Public Function
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Wrapper to the win API 'GetWindowsDirectory' - return the Windows Directory.

Procedure 'VBGetSystemDirectory'

List of procedures

Scope/Type	Public Function
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Wrapper to the win API 'GetSystemDirectory' - return the (Windows) System Directory.

Procedure 'NormalizePath'

List of procedures

Scope/Type	Public Function
Code parameters	Path As String
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Ensure path is ending on '\'.

Procedure 'DeNormalizePath'

List of procedures

Scope/Type	Public Function
Code parameters	Path As String
Code return value	String
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	If a path is ending on '\' delete the '\'.

Procedure 'PathExists'

List of procedures

Scope/Type	Public Function
Code parameters	Path As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Check if a path specified by parameiter exists.

Procedure 'FileToArray'

List of procedures

Scope/Type	Public Sub
Code parameters	ByVal File As String ByRef Lines
Code return value	String)
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Copy contens of a text file to a string array - that is each line in file will be an item in string array. 2nd parameter is expected to be a string array to which file content will be copied.

Procedure 'VBGetDiskFreeSpace'

List of procedures

Scope/Type	Public Function
Code parameters	Disk As String
Code return value	Double
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Wrapper to the Win API GetDiskFreeSpace function.

Procedure 'EnsureFileIsWriteable'

List of procedures

Scope/Type	Public Function
Code parameters	File As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Ensure that a file is writable - that is, file has write protection attribute not set.
Hint	This will probably modify the file attribute is necessary.

Procedure 'CreateFolderStructure'

List of procedures

Scope/Type	Public Function
Code parameters	ByVal NewFolder As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Create a complete folder structure, specified by parameter.

Procedure 'DeleteAnyFile'

List of procedures

Scope/Type	Public Function
Code parameters	Source As String Optional Options As Long = 0 Optional Owner As Long = hNull Optional ProgressTilte As String = ""
Code return value	Boolean
Author	Ralf Kunsmann
Date	2009-03-07
Purpose	Deleting a file, files or folder (folder structure) using the SHFileOperation win API function.

Procedure 'GetSystemDirectory'

List of procedures

Scope/Type	Public Function
Code return value	String
Author	Ralf Kunsmann
Date	2004 05 06
Purpose	VB version of GetSystemDirectory.
Result	String: The system directory

Procedure 'GetFileSize'

List of procedures

Scope/Type	Public Function
Code parameters	psFile As String
Code return value	Long
Author	Ralf Kunsmann
Date	2004 05 06
Purpose	VB version of GetFileSize.
Result	Long: The file size in Bytes.
In parameters	String (psFile): Full path of the regarding file.

Procedure 'FileBackup'

List of procedures

Scope/Type	Public Function
Code parameters	psFileName As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2005 01 20
Purpose	Make as Backup copy of a file.
Result	Boolean: True on success, else False.
In parameters	String psFileName: Path to the file to be backuped.

Procedure 'StringArrayToFile'

List of procedures

Scope/Type	Public Function
Code parameters	psFileName As String psData
Code return value	String
Author	Ralf Kunsmann
Date	2005 01 20
Purpose	Copy an array of strings (one array item per line) to a file.
Result	Boolean: True on success, else False.
In parameters	String psFileName: Path to the output file. String psData(): The string array, which is to be written.

Procedure 'StringToFile'

List of procedures

Scope/Type	Public Function
Code parameters	psData As String psFileName As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2005 01 24
Purpose	Copy a string to a file.
Result	Boolean: True on success, else False.
In parameters	String psFileName: Path to the output file. String psData: The string, which is to be written.

Procedure 'GetFiles'

List of procedures

Scope/Type	Public Sub
Code parameters	Path As String Optional ScanSubfolders As Boolean = True
Code return value	Collection
Author	Ralf Kunsmann
Date	2003 05 11
Purpose	Get a list of all files of a folder to a collection. Handle Sub Folders depending on 'ScanSubfolders' parameter.

Procedure 'PathAccessRights'

List of procedures

Scope/Type	Public Function
Code parameters	psPath As String
Code return value	Boolean
Author	Ralf Kunsmann
Date	2002 04 18
Purpose	Check if we have full access rights in certain path.
Result	Boolean: True if rights are ok, else False.
In parameters	String: Path to check.

Reporting date and time: 2009 03 07, 21:41:25 (year month day, hour:minute:second [24 hour format])