Namespace: Consultingwerk.Util
Class 
FileHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.FileHelper

Inherits: Progress.Lang.Object

File:FileHelper
Purpose:File System Helper methods
Syntax:Static methods only, Protected constructor to disallow
instance creation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jun 26 11:07:56 CEST 2011

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ LOGICAL CanFindTextInBinaryFile (character, character) Returns if the given string value can be found in the provided file name
+ CHARACTER CombinePath (character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character, character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character, character, character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character, character, character, character, character, character) Combines the provided path into a single path
+ CHARACTER CombinePath (character, character, character, character, character, character, character, character, character, character) Combines the provided path into a single path
+ CopyFiles (character, character, character) Copies files from one path to a target directory
+ CopyFiles (character, character, character, character) Copies files from one path to a target directory
+ CopyNonDbRcode (character, character) Copies r-code without DB-references from one path to a target directory
+ CopyNonDbRcode (character, character, character) Copies r-code without DB-references from one path to a target directory
+ INTEGER CreateDirectory (character) Creates all directories and subdirectories in the specified path.
+ INTEGER CreateDirectoryForFile (character) Creates the required directories to create the given file
+ DeleteEmptyDirectories (character) A Method for Deleting Empty Directories.
+ CHARACTER DescriptionForMimeType (character) Returns the description for the given mime type
+ CHARACTER DirectoryName (character) Returns the directory portion of a file name, absolutely or relatively
+ CHARACTER DirectoryName2 (character) Returns the directory portion of a file name, absolutely or relatively
+ EnsureFileNameCase (character) Ensures that the given OS file is cased in exactly the same way as passed in
+ CHARACTER EnsureFolderExists (character) Ensures that the folder referenced by the file name exists
+ LOGICAL Exists (character) Returns True when the file can be found in the PROPATH
+ CHARACTER FileExtension (character) Returns the file name extension of an operating system file excluding the dot (.). If the file does not have an extension, returns Null ("")
+ CHARACTER FileExtensionForMimeType (character) Returns the file extension for the given mime type
+ INT64 FileSize (character) Returns the file size of the given file
+ CHARACTER FindFile (character) Returns the absolute file name for the given file
+ CHARACTER FindFile (character, logical) Returns the absolute file name for the given file
+ GetFileList (character, character, datetime, table) Returns the List of files on disk for the specified criteria
+ GetFileList (character, character, table) Returns the List of files on disk for the specified criteria
+ GetFileListInDirectory (character, character, table) Returns the List of files on disk in the specified folder and the specified criteria
+ GetFileListNoDotNet (character, character, table) Returns the List of files on disk for the specified criteria
+ LONGCHAR GetFileText (character, logical) Reads the file and returns a LONGCHAR with the given line delimiter
+ CHARACTER GetTempFileName () Returns a temporary filename either using a .NET API or based on a GUID and the AVM SESSION:TEMP-DIRECTORY
+ CHARACTER HumanReadableFileSize (int64) Returns a human readable file size including the Unit
+ LOGICAL IsInProcedureLibrary (character) Returns if the given pathname is a file name reference from within a procedure library (.PL file)
+ LOGICAL IsRelativePath (character) Returns if the given file is a relative file name
+ CHARACTER MimeTypeForFileExtension (character) Returns the mime type for the given file extension
+ MoveFiles (character, character, character) Moves files from one path to a target directory
+ MoveFiles (character, character, character, character) Moves files from one path to a target directory
+ CHARACTER NormalizePathname (character) Returns a normalized path name
+ CHARACTER OS-ERROR-TEXT (integer) Returns the error message of an OS-ERROR value
+ CHARACTER ParentDirectory (character) Returns the parent directory based on the given directory
# CHARACTER ParentDirectoryUnix (character) Returns the parent directory based on the given directory
# CHARACTER ParentDirectoryWindows (character) Returns the parent directory based on the given directory
+ LOGICAL PromptOverwriteFile (character) Prompts to overwrite the given file
+ CHARACTER RelativeFileName (character) Return relative path if file is in propath
+ CHARACTER RemoveProcedureLibraryPath (character) Returns the actual file name from a file in a Procedure Library
+ CHARACTER ReplaceFileExtension (character, character) Replaces the extension of a file
+ CHARACTER SanitizePath (character) Returns the path name with slash/backslash depending on the OS
+ CHARACTER SanitizePathUnix (character) Returns the path name with Unix slashes
+ CHARACTER SanitizePathWindows (character) Returns the path name with Windows backslashes
+ CHARACTER ShortFileName (character) Returns just the file name portion of a relative or absolute file name
+ CHARACTER ShortFileNameWithoutExtension (character) Returns just the file name portion of a relative or absolute file name without the file extension
+ CHARACTER SubstituteSpecialFolderPath (character) Performs substitution of place holders (@{...}) based on the .NET Special Folders enumeration values

Top Constructor Summary
Options Name Purpose
# FileHelper () Disallow instance creation


Method Detail
Top

PUBLIC LOGICAL CanFindTextInBinaryFile (character, character)
Purpose: Returns if the given string value can be found in the provided file
name
Notes:

Parameters:
pcSearchString CHARACTER
The string value to search
pcFileName CHARACTER
The file name
Returns LOGICAL
Logical value indicating if the string can be found
Top

PUBLIC CHARACTER CombinePath (character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
pcPath5 CHARACTER
The fifth path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
pcPath5 CHARACTER
The fifth path entry to combine
pcPath6 CHARACTER
The sixth path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
pcPath5 CHARACTER
The fifth path entry to combine
pcPath6 CHARACTER
The sixth path entry to combine
pcPath7 CHARACTER
The seventh path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character, character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
pcPath5 CHARACTER
The fifth path entry to combine
pcPath6 CHARACTER
The sixth path entry to combine
pcPath7 CHARACTER
The seventh path entry to combine
pcPath8 CHARACTER
The eight path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character, character, character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
pcPath5 CHARACTER
The fifth path entry to combine
pcPath6 CHARACTER
The sixth path entry to combine
pcPath7 CHARACTER
The seventh path entry to combine
pcPath8 CHARACTER
The eight path entry to combine
pcPath9 CHARACTER
The ninth path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CHARACTER CombinePath (character, character, character, character, character, character, character, character, character, character)
Purpose: Combines the provided path into a single path
Notes: Does not validate the resulting path entry

Parameters:
pcPath1 CHARACTER
The first path entry to combine
pcPath2 CHARACTER
The second path entry to combine
pcPath3 CHARACTER
The third path entry to combine
pcPath4 CHARACTER
The fourth path entry to combine
pcPath5 CHARACTER
The fifth path entry to combine
pcPath6 CHARACTER
The sixth path entry to combine
pcPath7 CHARACTER
The seventh path entry to combine
pcPath8 CHARACTER
The eight path entry to combine
pcPath9 CHARACTER
The ninth path entry to combine
pcPath10 CHARACTER
The tenth path entry to combine
Returns CHARACTER
The combined path
Top

PUBLIC CopyFiles (character, character, character)
Purpose: Copies files from one path to a target directory
Notes:

Parameters:
pcSourcePath CHARACTER
The source file path
pcFileMask CHARACTER
A comma-delimited list of file patterns to copy (e.g. *.xml,*.resx)
pcTargetPath CHARACTER
The directory to copy into
Top

PUBLIC CopyFiles (character, character, character, character)
Purpose: Copies files from one path to a target directory
Notes:

Parameters:
pcSourcePath CHARACTER
The source file path
pcFileMask CHARACTER
A comma-delimited list of file patterns to copy (e.g. *.xml,*.resx)
pcExcludeFiles CHARACTER
A comma-delimited list of relative file names to exclude from copy
pcTargetPath CHARACTER
The directory to copy into
Top

PUBLIC CopyNonDbRcode (character, character)
Purpose: Copies r-code without DB-references from one path to a target directory
Notes:

Parameters:
pcSourcePath CHARACTER
The source file path
pcTargetPath CHARACTER
The directory to copy into
Top

PUBLIC CopyNonDbRcode (character, character, character)
Purpose: Copies r-code without DB-references from one path to a target directory
Notes:

Parameters:
pcSourcePath CHARACTER
The source file path
pcExcludeFiles CHARACTER
A comma-delimited list of relative file names to exclude from copy
pcTargetPath CHARACTER
The directory to copy into
Top

PUBLIC INTEGER CreateDirectory (character)
Purpose: Creates all directories and subdirectories in the specified path.
Notes:

Parameters:
pcPath CHARACTER
The path to create
Returns INTEGER
0 when success otherwise 999 on windows (Exception) or the OS-ERROR on UNIX
Top

PUBLIC INTEGER CreateDirectoryForFile (character)
Purpose: Creates the required directories to create the given file
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to create the directories for
Returns INTEGER
0 when success otherwise 999 on windows (Exception) or the OS-ERROR on UNIX
Top

PUBLIC DeleteEmptyDirectories (character)
Purpose: A Method for Deleting Empty Directories.
Notes:

Parameters:
pcDirectory CHARACTER
: character is the absolute path of the directory. Example:(c:\temp\)
Top

PUBLIC CHARACTER DescriptionForMimeType (character)
Purpose: Returns the description for the given mime type
Notes: Imports mime types from the MimeTypesList configuration setting
Defaults to Consultingwerk/Util/TempTables/mimetypes.csv

Parameters:
pcMimeType CHARACTER
The mime type to return the description for
Returns CHARACTER
The description
Top

PUBLIC CHARACTER DirectoryName (character)
Purpose: Returns the directory portion of a file name, absolutely or relatively
Notes:

Parameters:
pcFileName CHARACTER
The base file name
Returns CHARACTER
The directory portion of the file name
Top

PUBLIC CHARACTER DirectoryName2 (character)
Purpose: Returns the directory portion of a file name, absolutely or relatively
Notes: Ensures to return Windows path delimiter on Windows

Parameters:
pcFileName CHARACTER
The base file name
Returns CHARACTER
The directory portion of the file name
Top

PUBLIC EnsureFileNameCase (character)
Purpose: Ensures that the given OS file is cased in exactly the same way as
passed in
Notes:

Parameters:
pcFileName CHARACTER
The file name to verify
Top

PUBLIC CHARACTER EnsureFolderExists (character)
Purpose: Ensures that the folder referenced by the file name exists
Notes:

Parameters:
pcFileName CHARACTER
The file name to verify the folder for
Returns CHARACTER
The absolute file name of the folder
Top

PUBLIC LOGICAL Exists (character)
Purpose: Returns True when the file can be found in the PROPATH
Notes:

Parameters:
pcFileName CHARACTER
The file name to search
Returns LOGICAL
Logical value indicating if the file can be found
Top

PUBLIC CHARACTER FileExtension (character)
Purpose: Returns the file name extension of an operating system file excluding
the dot (.). If the file does not have an extension, returns Null ("")
Notes: Wrapper/facade to adecomm/_osfext.p, but excludes the leading dot

Parameters:
pcFileName CHARACTER
The name of the file to return the extension for
Returns CHARACTER
The file extension
Top

PUBLIC CHARACTER FileExtensionForMimeType (character)
Purpose: Returns the file extension for the given mime type
Notes: Imports mime types from the MimeTypesList configuration setting
Defaults to Consultingwerk/Util/TempTables/mimetypes.csv

Parameters:
pcMimeType CHARACTER
The mime type to return the file extension for
Returns CHARACTER
The file extension
Top

PUBLIC INT64 FileSize (character)
Purpose: Returns the file size of the given file
Notes:

Parameters:
pcFileName CHARACTER
The (relative file name)
Returns INT64
The file size
Top

PUBLIC CHARACTER FindFile (character)
Purpose: Returns the absolute file name for the given file
Notes:

Parameters:
pcFileName CHARACTER
The file name to search
Returns CHARACTER
The absolute path to the file or ? when the file is not found
Top

PUBLIC CHARACTER FindFile (character, logical)
Purpose: Returns the absolute file name for the given file
Notes:

Parameters:
pcFileName CHARACTER
The file name to search
plThrowOnInvalidFileName LOGICAL
Logical value indicating if the method should throw an error for an invalid file
Returns CHARACTER
The absolute path to the file or ? when the file is not found
Top

PUBLIC GetFileList (character, character, datetime, table)
Purpose: Returns the List of files on disk for the specified criteria
Notes:

Parameters:
pcDirectory CHARACTER
The directory to search files in (including subdirectories)
pcFileMask CHARACTER
A comma-delimited list of file name patterns to return (e.g. *.cls,*.w,*.p)
pdtModDate DATETIME
The last recent file mod date, only files more recent will be returned
ttFileNames TEMP-TABLE ttFileNames
OUTPUT TABLE containing the matching file names (Consultingwerk/Util/TempTables/ttFileNames.i)
Top

PUBLIC GetFileList (character, character, table)
Purpose: Returns the List of files on disk for the specified criteria
Notes:

Parameters:
pcDirectory CHARACTER
The directory to search files in (including subdirectories)
pcFileMask CHARACTER
A comma-delimited list of file name patterns to return (e.g. *.cls,*.w,*.p)
ttFileNames TEMP-TABLE ttFileNames
OUTPUT TABLE containing the matching file names (Consultingwerk/Util/TempTables/ttFileNames.i)
Top

PUBLIC GetFileListInDirectory (character, character, table)
Purpose: Returns the List of files on disk in the specified folder and the specified criteria
Notes:

Parameters:
pcDirectory CHARACTER
The directory to search files in (excluding subdirectories)
pcFileMask CHARACTER
A comma-delimited list of file name patterns to return (e.g. *.cls,*.w,*.p)
ttFileNames TEMP-TABLE ttFileNames
OUTPUT TABLE containing the matching file names (Consultingwerk/Util/TempTables/ttFileNames.i)
Top

PUBLIC GetFileListNoDotNet (character, character, table)
Purpose: Returns the List of files on disk for the specified criteria
Notes: The routine is an alternative to GetFileList and does not require
access to the .NET Framework (suitable for 10.2B AppServer and
UNIX)

Parameters:
pcDirectory CHARACTER
The directory to search files in (including subdirectories)
pcFileMask CHARACTER
A comma-delimited list of file name patterns to return (e.g. *.cls,*.w,*.p)
ttFileNames TEMP-TABLE ttFileNames
OUTPUT TABLE containing the matching file names (Consultingwerk/Util/TempTables/ttFileNames.i)
Top

PUBLIC LONGCHAR GetFileText (character, logical)
Purpose: Reads the file and returns a LONGCHAR with the given
line delimiter
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to import
plCrLf LOGICAL
Use CR/LF (TRUE) or LF as the line delimiter
Returns LONGCHAR
The LONGCHAR with the text file contents
Top

PUBLIC CHARACTER GetTempFileName ()
Purpose: Returns a temporary filename either using a .NET API or based on
a GUID and the AVM SESSION:TEMP-DIRECTORY
Notes: The .NET GUI will create an empty temp-file to "block" the file

Returns CHARACTER
The name for a temporary file
Top

PUBLIC CHARACTER HumanReadableFileSize (int64)
Purpose: Returns a human readable file size including the Unit
Notes: E.g 10 Bytes, 20 kB, 1.2 MB, ...

Parameters:
piFileSize INT64
The file size to convert into a human readable file size
Returns CHARACTER
The string with the file size including the unit
Top

PUBLIC LOGICAL IsInProcedureLibrary (character)
Purpose: Returns if the given pathname is a file name reference from within a
procedure library (.PL file)
Notes: Returns true for file names like
C:\Progress\OpenEdge122_64\gui\netlib\OpenEdge.Net.pl<<OpenEdge\Web\WebHandler.r>> \Progress\OpenEdge122_64\gui\netlib\OpenEdge.Net.pl<<OpenEdge\Web\WebHandler.r>>

Parameters:
pcPath CHARACTER
The path reference to be checked
Returns LOGICAL
Logical value indicating if the file name reference from within a procedure library
Top

PUBLIC LOGICAL IsRelativePath (character)
Purpose: Returns if the given file is a relative file name
Notes: Absolute file names begins with / or \ or the second character is a :

Parameters:
pcPath CHARACTER
The path name to test
Returns LOGICAL
Logical value indicating if the given path is a relative path
Top

PUBLIC CHARACTER MimeTypeForFileExtension (character)
Purpose: Returns the mime type for the given file extension
Notes: Imports mime types from the MimeTypesList configuration setting
Defaults to Consultingwerk/Util/TempTables/mimetypes.csv

Parameters:
pcExtension CHARACTER
The file extension to return the mime type for
Returns CHARACTER
The mime type
Top

PUBLIC MoveFiles (character, character, character)
Purpose: Moves files from one path to a target directory
Notes:

Parameters:
pcSourcePath CHARACTER
The source file path
pcFileMask CHARACTER
A comma-delimited list of file patterns to copy (e.g. *.xml,*.resx)
pcTargetPath CHARACTER
The directory to copy into
Top

PUBLIC MoveFiles (character, character, character, character)
Purpose: Moves files from one path to a target directory
Notes:

Parameters:
pcSourcePath CHARACTER
The source file path
pcFileMask CHARACTER
A comma-delimited list of file patterns to copy (e.g. *.xml,*.resx)
pcExcludeFiles CHARACTER
A comma-delimited list of relative file names to exclude from copy
pcTargetPath CHARACTER
The directory to copy into
Top

PUBLIC CHARACTER NormalizePathname (character)
Purpose: Returns a normalized path name
Notes: Replaces back slash with forward slash

Parameters:
pcSourcePathname CHARACTER
The source path name
Returns CHARACTER
The path name with forward slashes only
Top

PUBLIC CHARACTER OS-ERROR-TEXT (integer)
Purpose: Returns the error message of an OS-ERROR value
Notes:

Parameters:
piOSError INTEGER
The OS-ERROR Error code
Returns CHARACTER
The OS-ERROR Text
Top

PUBLIC CHARACTER ParentDirectory (character)
Purpose: Returns the parent directory based on the given directory
Notes: Returns ? when called for the root folder

Parameters:
pcDirectoryName CHARACTER
The name of the directory who's parent directory should be returned
Returns CHARACTER
The parent directory
Top

PROTECTED CHARACTER ParentDirectoryUnix (character)
Purpose: Returns the parent directory based on the given directory
Notes: Returns ? when called for the root folder

Parameters:
pcDirectoryName CHARACTER
The name of the directory who's parent directory should be returned
Returns CHARACTER
The parent directory
Top

PROTECTED CHARACTER ParentDirectoryWindows (character)
Purpose: Returns the parent directory based on the given directory
Notes: Returns ? when called for the root folder

Parameters:
pcDirectoryName CHARACTER
The name of the directory who's parent directory should be returned
Returns CHARACTER
The parent directory
Top

PUBLIC LOGICAL PromptOverwriteFile (character)
Purpose: Prompts to overwrite the given file
Notes: Checks if file exists before overwriting

Parameters:
pcFileName CHARACTER
The file name to overwrite
Returns LOGICAL
Logical value indicating if the file should be overwritten
Top

PUBLIC CHARACTER RelativeFileName (character)
Purpose: Return relative path if file is in propath
Notes: Based on adecomm/_relfile.p

Parameters:
pcFileName CHARACTER
The (absolute) name of a file
Returns CHARACTER
The relative file name based on the current propath
Top

PUBLIC CHARACTER RemoveProcedureLibraryPath (character)
Purpose: Returns the actual file name from a file in a Procedure Library
Notes: Returns OpenEdge\Web\WebHandler.r from
C:\Progress\OpenEdge122_64\gui\netlib\OpenEdge.Net.pl<<OpenEdge\Web\WebHandler.r>> \Progress\OpenEdge122_64\gui\netlib\OpenEdge.Net.pl<<OpenEdge\Web\WebHandler.r>>

Parameters:
pcPath CHARACTER
The Path in the Procedure Library
Returns CHARACTER
The actual file name
Top

PUBLIC CHARACTER ReplaceFileExtension (character, character)
Purpose: Replaces the extension of a file
Notes: When the source file name does not have an extension, the extension
will be added

Parameters:
pcSourceFileName CHARACTER
The original file name optionally including a path
pcExtension CHARACTER
The extension to use in the returned file name
Returns CHARACTER
The target file name with the replaces extension
Top

PUBLIC CHARACTER SanitizePath (character)
Purpose: Returns the path name with slash/backslash depending on the OS
Notes:

Parameters:
pcPath CHARACTER
The path
Returns CHARACTER
The path with Unix slashes or Windows backslashes
Top

PUBLIC CHARACTER SanitizePathUnix (character)
Purpose: Returns the path name with Unix slashes
Notes:

Parameters:
pcPath CHARACTER
The path
Returns CHARACTER
The path with Unix slashes
Top

PUBLIC CHARACTER SanitizePathWindows (character)
Purpose: Returns the path name with Windows backslashes
Notes:

Parameters:
pcPath CHARACTER
The path
Returns CHARACTER
The path with Windows backslashes
Top

PUBLIC CHARACTER ShortFileName (character)
Purpose: Returns just the file name portion of a relative or absolute file
name
Notes:

Parameters:
pcPath CHARACTER
The base path
Returns CHARACTER
The file name portion of the path
Top

PUBLIC CHARACTER ShortFileNameWithoutExtension (character)
Purpose: Returns just the file name portion of a relative or absolute file
name without the file extension
Notes:

Parameters:
pcPath CHARACTER
The base path
Returns CHARACTER
The file name portion of the path without the file extension
Top

PUBLIC CHARACTER SubstituteSpecialFolderPath (character)
Purpose: Performs substitution of place holders (@{...}) based on the .NET Special Folders
enumeration values
Notes: See https://learn.microsoft.com/en-us/dotnet/api/system.environment.specialfolder

Parameters:
pcPath CHARACTER
The path including a reference to a special folder, please @{LocalApplicationData}
Returns CHARACTER
The actual folder name


Constructor Detail
Top

PROTECTED FileHelper ()
Purpose: Disallow instance creation
Notes:



Temp-Table Detail

Temp-Table ttFileNames

Defined in:


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:16:38