Path
Overview
Filesystem related utilities.
Location
-
Reference:
- Elements.dll .NET, .NET Core 6.0, .NET Standard 2.0
- elements.jar Cooper
- Elements.fx Island, ToffeeV2
- libElements.fx Toffee
- Namespace: RemObjects.Elements.RTL
ChangeExtension
Change the extension of this file to something else. Pass an empty string to remove the extension.
class method ChangeExtension(aFileName: not nullable String; aNewExtension: nullable String): not nullable String
static String! ChangeExtension(String! aFileName, String? aNewExtension)
// Toffee
static func ChangeExtension(_ aFileName: String, _ aNewExtension: String) -> String
// ToffeeV2
static func ChangeExtension(_ aFileName: String, _ aNewExtension: String?) -> String
static String ChangeExtension(String aFileName, String aNewExtension)
Shared Function ChangeExtension(aFileName As String, aNewExtension As String?) As String
Parameters:
- aFileName:
- aNewExtension:
Combine
Append multiple paths together, using the directory seperator to bind them.
class method Combine(aBasePath: nullable String; params aPaths: array of String): nullable String
static String? Combine(String? aBasePath, params String[] aPaths)
// Toffee
static func Combine(_ aBasePath: String, _ aPaths: String...) -> String
// ToffeeV2
static func Combine(_ aBasePath: String?, _ aPaths: String...) -> String?
static String Combine(String aBasePath, String[]... aPaths)
Shared Function Combine(aBasePath As String?, ParamArray aPaths As String()) As String?
Parameters:
- aBasePath:
- aPaths:
CombineUnixPath
Append multiple paths together, using the unix directory seperator to bind them.
class method CombineUnixPath(aBasePath: not nullable String; params aPaths: array of String): not nullable String
static String! CombineUnixPath(String! aBasePath, params String[] aPaths)
static func CombineUnixPath(_ aBasePath: String, _ aPaths: String...) -> String
static String CombineUnixPath(String aBasePath, String[]... aPaths)
Shared Function CombineUnixPath(aBasePath As String, ParamArray aPaths As String()) As String
Parameters:
- aBasePath:
- aPaths:
CombineWindowsPath
Append multiple paths together, using the windows directory seperator to bind them.
class method CombineWindowsPath(aBasePath: not nullable String; params aPaths: array of String): not nullable String
static String! CombineWindowsPath(String! aBasePath, params String[] aPaths)
static func CombineWindowsPath(_ aBasePath: String, _ aPaths: String...) -> String
static String CombineWindowsPath(String aBasePath, String[]... aPaths)
Shared Function CombineWindowsPath(aBasePath As String, ParamArray aPaths As String()) As String
Parameters:
- aBasePath:
- aPaths:
DirectorySeparatorChar
Returns the system directory seperator character.
class property DirectorySeparatorChar: Char read;
class Char DirectorySeparatorChar { get; }
static var DirectorySeparatorChar: Char { get{} }
class Char DirectorySeparatorChar { __get; }
Shared ReadOnly Property DirectorySeparatorChar() As Char
ExpandTildeInPath Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Toffee, ToffeeV2
Expand a ~/ path to the users real home directory. Does nothing with the string if does not start with ~
class method ExpandTildeInPath(aPath: not nullable String): not nullable String
static String! ExpandTildeInPath(String! aPath)
static func ExpandTildeInPath(_ aPath: String) -> String
Shared Function ExpandTildeInPath(aPath As String) As String
Parameters:
- aPath:
FirstFileThatExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstFileThatExists(params aFiles: nullable IEnumerable<String>): nullable String
static String? FirstFileThatExists(params IEnumerable<String>? aFiles)
// Toffee
static func FirstFileThatExists(_ aFiles: String...) -> String
// ToffeeV2
static func FirstFileThatExists(_ aFiles: IEnumerable<String>?...) -> String?
static String FirstFileThatExists(Iterable<String>... aFiles)
Shared Function FirstFileThatExists(ParamArray aFiles As IEnumerable<String>?) As String?
Parameters:
- aFiles:
FirstFolderThatExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstFolderThatExists(params aFolders: nullable IEnumerable<String>): nullable String
static String? FirstFolderThatExists(params IEnumerable<String>? aFolders)
// Toffee
static func FirstFolderThatExists(_ aFolders: String...) -> String
// ToffeeV2
static func FirstFolderThatExists(_ aFolders: IEnumerable<String>?...) -> String?
static String FirstFolderThatExists(Iterable<String>... aFolders)
Shared Function FirstFolderThatExists(ParamArray aFolders As IEnumerable<String>?) As String?
Parameters:
- aFolders:
FirstMatchingSubfolder (String, not nullable IEnumerable<String>): nullable String .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: not nullable IEnumerable<String>): nullable String
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String>! aSubFolderOptions)
// Toffee
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: INSFastEnumeration<String>) -> String
// ToffeeV2
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: IEnumerable<String>) -> String?
static String FirstMatchingSubfolder(String aFolder, Iterable<String> aSubFolderOptions)
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
FirstMatchingSubfolder (String, not nullable IEnumerable<String>, Func<String, String, String>): nullable String .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: not nullable IEnumerable<String>; aBuildPath: Func<String, String, String>): nullable String
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String>! aSubFolderOptions, Func<String, String, String> aBuildPath)
// Toffee
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: INSFastEnumeration<String>, _ aBuildPath: (String, String) -> String) -> String
// ToffeeV2
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: IEnumerable<String>, _ aBuildPath: (String, String) -> String) -> String?
static String FirstMatchingSubfolder(String aFolder, Iterable<String> aSubFolderOptions, Func3<String, String, String> aBuildPath)
// .NET, .NET Core 6.0, .NET Standard 2.0
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>, aBuildPath As Func (Of String, String, String)) As String?
// Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>, aBuildPath As Func<String, String, String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
- aBuildPath:
FirstPathThatExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstPathThatExists(params aPaths: nullable IEnumerable<String>): nullable String
static String? FirstPathThatExists(params IEnumerable<String>? aPaths)
// Toffee
static func FirstPathThatExists(_ aPaths: String...) -> String
// ToffeeV2
static func FirstPathThatExists(_ aPaths: IEnumerable<String>?...) -> String?
static String FirstPathThatExists(Iterable<String>... aPaths)
Shared Function FirstPathThatExists(ParamArray aPaths As IEnumerable<String>?) As String?
Parameters:
- aPaths:
ForceTrailingDirectorySeparator
class method ForceTrailingDirectorySeparator(aPath: not nullable String): not nullable String
static String! ForceTrailingDirectorySeparator(String! aPath)
static func ForceTrailingDirectorySeparator(_ aPath: String) -> String
static String ForceTrailingDirectorySeparator(String aPath)
Shared Function ForceTrailingDirectorySeparator(aPath As String) As String
Parameters:
- aPath:
GetExtension
Returns the extension, including the .
class method GetExtension(aFileName: not nullable String): not nullable String
static String! GetExtension(String! aFileName)
static func GetExtension(_ aFileName: String) -> String
static String GetExtension(String aFileName)
Shared Function GetExtension(aFileName As String) As String
Parameters:
- aFileName:
GetFileName
Returns the filename of a file, without the directory.
class method GetFileName(aFileName: not nullable String): not nullable String
static String! GetFileName(String! aFileName)
static func GetFileName(_ aFileName: String) -> String
static String GetFileName(String aFileName)
Shared Function GetFileName(aFileName As String) As String
Parameters:
- aFileName:
GetFileNameWithoutExtension
Returns the filename of a file, without the directory or extension.
class method GetFileNameWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetFileNameWithoutExtension(String! aFileName)
static func GetFileNameWithoutExtension(_ aFileName: String) -> String
static String GetFileNameWithoutExtension(String aFileName)
Shared Function GetFileNameWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetFullPath .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
Returns the full path name, expanding any relative or .. / . paths.
class method GetFullPath(RelativePath: not nullable String): not nullable String
static String! GetFullPath(String! RelativePath)
static func GetFullPath(_ RelativePath: String) -> String
static String GetFullPath(String RelativePath)
Shared Function GetFullPath(RelativePath As String) As String
Parameters:
- RelativePath:
GetNetworkServerName
Returns the network path used in a path; returns nothing if it's not a network path.
class method GetNetworkServerName(aFileName: not nullable String): nullable String
static String? GetNetworkServerName(String! aFileName)
// Toffee
static func GetNetworkServerName(_ aFileName: String) -> String
// ToffeeV2
static func GetNetworkServerName(_ aFileName: String) -> String?
static String GetNetworkServerName(String aFileName)
Shared Function GetNetworkServerName(aFileName As String) As String?
Parameters:
- aFileName:
class method GetParentDirectory(aFileName: not nullable String) FolderSeparator(aFolderSeparator: Char): nullable String
static String? GetParentDirectory(String! aFileName) FolderSeparator(Char aFolderSeparator)
// Toffee
static func GetParentDirectory(_ aFileName: String, FolderSeparator aFolderSeparator: Char) -> String
// ToffeeV2
static func GetParentDirectory(_ aFileName: String, FolderSeparator aFolderSeparator: Char) -> String?
static String GetParentDirectory(String aFileName) FolderSeparator(Char aFolderSeparator)
Shared Function GetParentDirectory(aFileName As String) FolderSeparator(aFolderSeparator As Char) As String?
Parameters:
- aFileName:
- aFolderSeparator:
Returns the parent directory for a file or directory.
class method GetParentDirectory(aFileName: not nullable String): nullable String
static String? GetParentDirectory(String! aFileName)
// Toffee
static func GetParentDirectory(_ aFileName: String) -> String
// ToffeeV2
static func GetParentDirectory(_ aFileName: String) -> String?
static String GetParentDirectory(String aFileName)
Shared Function GetParentDirectory(aFileName As String) As String?
Parameters:
- aFileName:
GetPath
Resolves a path, relative to another path.
class method GetPath(aFullPath: not nullable String) RelativeToPath(aBasePath: not nullable String): nullable String
static String? GetPath(String! aFullPath) RelativeToPath(String! aBasePath)
// Toffee
static func GetPath(_ aFullPath: String, RelativeToPath aBasePath: String) -> String
// ToffeeV2
static func GetPath(_ aFullPath: String, RelativeToPath aBasePath: String) -> String?
static String GetPath(String aFullPath) RelativeToPath(String aBasePath)
Shared Function GetPath(aFullPath As String) RelativeToPath(aBasePath As String) As String?
Parameters:
- aFullPath:
- aBasePath:
GetPathWithoutExtension
Returns a filename using the unix file seperator.
class method GetPathWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetPathWithoutExtension(String! aFileName)
static func GetPathWithoutExtension(_ aFileName: String) -> String
static String GetPathWithoutExtension(String aFileName)
Shared Function GetPathWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetUnixFileName
Returns a file as unix filename.
class method GetUnixFileName(aFileName: not nullable String): not nullable String
static String! GetUnixFileName(String! aFileName)
static func GetUnixFileName(_ aFileName: String) -> String
static String GetUnixFileName(String aFileName)
Shared Function GetUnixFileName(aFileName As String) As String
Parameters:
- aFileName:
GetUnixFileNameWithoutExtension
Returns a file as unix filename without extension.
class method GetUnixFileNameWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetUnixFileNameWithoutExtension(String! aFileName)
static func GetUnixFileNameWithoutExtension(_ aFileName: String) -> String
static String GetUnixFileNameWithoutExtension(String aFileName)
Shared Function GetUnixFileNameWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetUnixParentDirectory
Returns the parent directory of a unix plath.
class method GetUnixParentDirectory(aFileName: not nullable String): nullable String
static String? GetUnixParentDirectory(String! aFileName)
// Toffee
static func GetUnixParentDirectory(_ aFileName: String) -> String
// ToffeeV2
static func GetUnixParentDirectory(_ aFileName: String) -> String?
static String GetUnixParentDirectory(String aFileName)
Shared Function GetUnixParentDirectory(aFileName As String) As String?
Parameters:
- aFileName:
GetWindowsFileName
Returns a filename using the windows file seperator.
class method GetWindowsFileName(aFileName: not nullable String): not nullable String
static String! GetWindowsFileName(String! aFileName)
static func GetWindowsFileName(_ aFileName: String) -> String
static String GetWindowsFileName(String aFileName)
Shared Function GetWindowsFileName(aFileName As String) As String
Parameters:
- aFileName:
GetWindowsFileNameWithoutExtension
Returns a file as Windows filename without extension.
class method GetWindowsFileNameWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetWindowsFileNameWithoutExtension(String! aFileName)
static func GetWindowsFileNameWithoutExtension(_ aFileName: String) -> String
static String GetWindowsFileNameWithoutExtension(String aFileName)
Shared Function GetWindowsFileNameWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetWindowsParentDirectory
Returns the parent directory of a windows path.
class method GetWindowsParentDirectory(aFileName: not nullable String): nullable String
static String? GetWindowsParentDirectory(String! aFileName)
// Toffee
static func GetWindowsParentDirectory(_ aFileName: String) -> String
// ToffeeV2
static func GetWindowsParentDirectory(_ aFileName: String) -> String?
static String GetWindowsParentDirectory(String aFileName)
Shared Function GetWindowsParentDirectory(aFileName As String) As String?
Parameters:
- aFileName:
PathListSeparatorChar
Separator characters for summing up multiple paths; generally ; or :.
class property PathListSeparatorChar: Char read;
class Char PathListSeparatorChar { get; }
static var PathListSeparatorChar: Char { get{} }
class Char PathListSeparatorChar { __get; }
Shared ReadOnly Property PathListSeparatorChar() As Char
TrimTrailingDirectorySeparator
class method TrimTrailingDirectorySeparator(aPath: not nullable String): not nullable String
static String! TrimTrailingDirectorySeparator(String! aPath)
static func TrimTrailingDirectorySeparator(_ aPath: String) -> String
static String TrimTrailingDirectorySeparator(String aPath)
Shared Function TrimTrailingDirectorySeparator(aPath As String) As String
Parameters:
- aPath:
DirectorySeparatorChar
Returns the system directory seperator character.
class property DirectorySeparatorChar: Char read;
class Char DirectorySeparatorChar { get; }
static var DirectorySeparatorChar: Char { get{} }
class Char DirectorySeparatorChar { __get; }
Shared ReadOnly Property DirectorySeparatorChar() As Char
PathListSeparatorChar
Separator characters for summing up multiple paths; generally ; or :.
class property PathListSeparatorChar: Char read;
class Char PathListSeparatorChar { get; }
static var PathListSeparatorChar: Char { get{} }
class Char PathListSeparatorChar { __get; }
Shared ReadOnly Property PathListSeparatorChar() As Char
ChangeExtension
Change the extension of this file to something else. Pass an empty string to remove the extension.
class method ChangeExtension(aFileName: not nullable String; aNewExtension: nullable String): not nullable String
static String! ChangeExtension(String! aFileName, String? aNewExtension)
// Toffee
static func ChangeExtension(_ aFileName: String, _ aNewExtension: String) -> String
// ToffeeV2
static func ChangeExtension(_ aFileName: String, _ aNewExtension: String?) -> String
static String ChangeExtension(String aFileName, String aNewExtension)
Shared Function ChangeExtension(aFileName As String, aNewExtension As String?) As String
Parameters:
- aFileName:
- aNewExtension:
Combine
Append multiple paths together, using the directory seperator to bind them.
class method Combine(aBasePath: nullable String; params aPaths: array of String): nullable String
static String? Combine(String? aBasePath, params String[] aPaths)
// Toffee
static func Combine(_ aBasePath: String, _ aPaths: String...) -> String
// ToffeeV2
static func Combine(_ aBasePath: String?, _ aPaths: String...) -> String?
static String Combine(String aBasePath, String[]... aPaths)
Shared Function Combine(aBasePath As String?, ParamArray aPaths As String()) As String?
Parameters:
- aBasePath:
- aPaths:
CombineUnixPath
Append multiple paths together, using the unix directory seperator to bind them.
class method CombineUnixPath(aBasePath: not nullable String; params aPaths: array of String): not nullable String
static String! CombineUnixPath(String! aBasePath, params String[] aPaths)
static func CombineUnixPath(_ aBasePath: String, _ aPaths: String...) -> String
static String CombineUnixPath(String aBasePath, String[]... aPaths)
Shared Function CombineUnixPath(aBasePath As String, ParamArray aPaths As String()) As String
Parameters:
- aBasePath:
- aPaths:
CombineWindowsPath
Append multiple paths together, using the windows directory seperator to bind them.
class method CombineWindowsPath(aBasePath: not nullable String; params aPaths: array of String): not nullable String
static String! CombineWindowsPath(String! aBasePath, params String[] aPaths)
static func CombineWindowsPath(_ aBasePath: String, _ aPaths: String...) -> String
static String CombineWindowsPath(String aBasePath, String[]... aPaths)
Shared Function CombineWindowsPath(aBasePath As String, ParamArray aPaths As String()) As String
Parameters:
- aBasePath:
- aPaths:
ExpandTildeInPath Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Toffee, ToffeeV2
Expand a ~/ path to the users real home directory. Does nothing with the string if does not start with ~
class method ExpandTildeInPath(aPath: not nullable String): not nullable String
static String! ExpandTildeInPath(String! aPath)
static func ExpandTildeInPath(_ aPath: String) -> String
Shared Function ExpandTildeInPath(aPath As String) As String
Parameters:
- aPath:
FirstFileThatExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstFileThatExists(params aFiles: nullable IEnumerable<String>): nullable String
static String? FirstFileThatExists(params IEnumerable<String>? aFiles)
// Toffee
static func FirstFileThatExists(_ aFiles: String...) -> String
// ToffeeV2
static func FirstFileThatExists(_ aFiles: IEnumerable<String>?...) -> String?
static String FirstFileThatExists(Iterable<String>... aFiles)
Shared Function FirstFileThatExists(ParamArray aFiles As IEnumerable<String>?) As String?
Parameters:
- aFiles:
FirstFolderThatExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstFolderThatExists(params aFolders: nullable IEnumerable<String>): nullable String
static String? FirstFolderThatExists(params IEnumerable<String>? aFolders)
// Toffee
static func FirstFolderThatExists(_ aFolders: String...) -> String
// ToffeeV2
static func FirstFolderThatExists(_ aFolders: IEnumerable<String>?...) -> String?
static String FirstFolderThatExists(Iterable<String>... aFolders)
Shared Function FirstFolderThatExists(ParamArray aFolders As IEnumerable<String>?) As String?
Parameters:
- aFolders:
FirstMatchingSubfolder (String, not nullable IEnumerable<String>): nullable String .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: not nullable IEnumerable<String>): nullable String
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String>! aSubFolderOptions)
// Toffee
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: INSFastEnumeration<String>) -> String
// ToffeeV2
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: IEnumerable<String>) -> String?
static String FirstMatchingSubfolder(String aFolder, Iterable<String> aSubFolderOptions)
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
FirstMatchingSubfolder (String, not nullable IEnumerable<String>, Func<String, String, String>): nullable String .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: not nullable IEnumerable<String>; aBuildPath: Func<String, String, String>): nullable String
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String>! aSubFolderOptions, Func<String, String, String> aBuildPath)
// Toffee
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: INSFastEnumeration<String>, _ aBuildPath: (String, String) -> String) -> String
// ToffeeV2
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: IEnumerable<String>, _ aBuildPath: (String, String) -> String) -> String?
static String FirstMatchingSubfolder(String aFolder, Iterable<String> aSubFolderOptions, Func3<String, String, String> aBuildPath)
// .NET, .NET Core 6.0, .NET Standard 2.0
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>, aBuildPath As Func (Of String, String, String)) As String?
// Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>, aBuildPath As Func<String, String, String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
- aBuildPath:
FirstPathThatExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
class method FirstPathThatExists(params aPaths: nullable IEnumerable<String>): nullable String
static String? FirstPathThatExists(params IEnumerable<String>? aPaths)
// Toffee
static func FirstPathThatExists(_ aPaths: String...) -> String
// ToffeeV2
static func FirstPathThatExists(_ aPaths: IEnumerable<String>?...) -> String?
static String FirstPathThatExists(Iterable<String>... aPaths)
Shared Function FirstPathThatExists(ParamArray aPaths As IEnumerable<String>?) As String?
Parameters:
- aPaths:
ForceTrailingDirectorySeparator
class method ForceTrailingDirectorySeparator(aPath: not nullable String): not nullable String
static String! ForceTrailingDirectorySeparator(String! aPath)
static func ForceTrailingDirectorySeparator(_ aPath: String) -> String
static String ForceTrailingDirectorySeparator(String aPath)
Shared Function ForceTrailingDirectorySeparator(aPath As String) As String
Parameters:
- aPath:
GetExtension
Returns the extension, including the .
class method GetExtension(aFileName: not nullable String): not nullable String
static String! GetExtension(String! aFileName)
static func GetExtension(_ aFileName: String) -> String
static String GetExtension(String aFileName)
Shared Function GetExtension(aFileName As String) As String
Parameters:
- aFileName:
GetFileName
Returns the filename of a file, without the directory.
class method GetFileName(aFileName: not nullable String): not nullable String
static String! GetFileName(String! aFileName)
static func GetFileName(_ aFileName: String) -> String
static String GetFileName(String aFileName)
Shared Function GetFileName(aFileName As String) As String
Parameters:
- aFileName:
GetFileNameWithoutExtension
Returns the filename of a file, without the directory or extension.
class method GetFileNameWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetFileNameWithoutExtension(String! aFileName)
static func GetFileNameWithoutExtension(_ aFileName: String) -> String
static String GetFileNameWithoutExtension(String aFileName)
Shared Function GetFileNameWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetFullPath .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2
Returns the full path name, expanding any relative or .. / . paths.
class method GetFullPath(RelativePath: not nullable String): not nullable String
static String! GetFullPath(String! RelativePath)
static func GetFullPath(_ RelativePath: String) -> String
static String GetFullPath(String RelativePath)
Shared Function GetFullPath(RelativePath As String) As String
Parameters:
- RelativePath:
GetNetworkServerName
Returns the network path used in a path; returns nothing if it's not a network path.
class method GetNetworkServerName(aFileName: not nullable String): nullable String
static String? GetNetworkServerName(String! aFileName)
// Toffee
static func GetNetworkServerName(_ aFileName: String) -> String
// ToffeeV2
static func GetNetworkServerName(_ aFileName: String) -> String?
static String GetNetworkServerName(String aFileName)
Shared Function GetNetworkServerName(aFileName As String) As String?
Parameters:
- aFileName:
class method GetParentDirectory(aFileName: not nullable String) FolderSeparator(aFolderSeparator: Char): nullable String
static String? GetParentDirectory(String! aFileName) FolderSeparator(Char aFolderSeparator)
// Toffee
static func GetParentDirectory(_ aFileName: String, FolderSeparator aFolderSeparator: Char) -> String
// ToffeeV2
static func GetParentDirectory(_ aFileName: String, FolderSeparator aFolderSeparator: Char) -> String?
static String GetParentDirectory(String aFileName) FolderSeparator(Char aFolderSeparator)
Shared Function GetParentDirectory(aFileName As String) FolderSeparator(aFolderSeparator As Char) As String?
Parameters:
- aFileName:
- aFolderSeparator:
Returns the parent directory for a file or directory.
class method GetParentDirectory(aFileName: not nullable String): nullable String
static String? GetParentDirectory(String! aFileName)
// Toffee
static func GetParentDirectory(_ aFileName: String) -> String
// ToffeeV2
static func GetParentDirectory(_ aFileName: String) -> String?
static String GetParentDirectory(String aFileName)
Shared Function GetParentDirectory(aFileName As String) As String?
Parameters:
- aFileName:
GetPath
Resolves a path, relative to another path.
class method GetPath(aFullPath: not nullable String) RelativeToPath(aBasePath: not nullable String): nullable String
static String? GetPath(String! aFullPath) RelativeToPath(String! aBasePath)
// Toffee
static func GetPath(_ aFullPath: String, RelativeToPath aBasePath: String) -> String
// ToffeeV2
static func GetPath(_ aFullPath: String, RelativeToPath aBasePath: String) -> String?
static String GetPath(String aFullPath) RelativeToPath(String aBasePath)
Shared Function GetPath(aFullPath As String) RelativeToPath(aBasePath As String) As String?
Parameters:
- aFullPath:
- aBasePath:
GetPathWithoutExtension
Returns a filename using the unix file seperator.
class method GetPathWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetPathWithoutExtension(String! aFileName)
static func GetPathWithoutExtension(_ aFileName: String) -> String
static String GetPathWithoutExtension(String aFileName)
Shared Function GetPathWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetUnixFileName
Returns a file as unix filename.
class method GetUnixFileName(aFileName: not nullable String): not nullable String
static String! GetUnixFileName(String! aFileName)
static func GetUnixFileName(_ aFileName: String) -> String
static String GetUnixFileName(String aFileName)
Shared Function GetUnixFileName(aFileName As String) As String
Parameters:
- aFileName:
GetUnixFileNameWithoutExtension
Returns a file as unix filename without extension.
class method GetUnixFileNameWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetUnixFileNameWithoutExtension(String! aFileName)
static func GetUnixFileNameWithoutExtension(_ aFileName: String) -> String
static String GetUnixFileNameWithoutExtension(String aFileName)
Shared Function GetUnixFileNameWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetUnixParentDirectory
Returns the parent directory of a unix plath.
class method GetUnixParentDirectory(aFileName: not nullable String): nullable String
static String? GetUnixParentDirectory(String! aFileName)
// Toffee
static func GetUnixParentDirectory(_ aFileName: String) -> String
// ToffeeV2
static func GetUnixParentDirectory(_ aFileName: String) -> String?
static String GetUnixParentDirectory(String aFileName)
Shared Function GetUnixParentDirectory(aFileName As String) As String?
Parameters:
- aFileName:
GetWindowsFileName
Returns a filename using the windows file seperator.
class method GetWindowsFileName(aFileName: not nullable String): not nullable String
static String! GetWindowsFileName(String! aFileName)
static func GetWindowsFileName(_ aFileName: String) -> String
static String GetWindowsFileName(String aFileName)
Shared Function GetWindowsFileName(aFileName As String) As String
Parameters:
- aFileName:
GetWindowsFileNameWithoutExtension
Returns a file as Windows filename without extension.
class method GetWindowsFileNameWithoutExtension(aFileName: not nullable String): not nullable String
static String! GetWindowsFileNameWithoutExtension(String! aFileName)
static func GetWindowsFileNameWithoutExtension(_ aFileName: String) -> String
static String GetWindowsFileNameWithoutExtension(String aFileName)
Shared Function GetWindowsFileNameWithoutExtension(aFileName As String) As String
Parameters:
- aFileName:
GetWindowsParentDirectory
Returns the parent directory of a windows path.
class method GetWindowsParentDirectory(aFileName: not nullable String): nullable String
static String? GetWindowsParentDirectory(String! aFileName)
// Toffee
static func GetWindowsParentDirectory(_ aFileName: String) -> String
// ToffeeV2
static func GetWindowsParentDirectory(_ aFileName: String) -> String?
static String GetWindowsParentDirectory(String aFileName)
Shared Function GetWindowsParentDirectory(aFileName As String) As String?
Parameters:
- aFileName:
TrimTrailingDirectorySeparator
class method TrimTrailingDirectorySeparator(aPath: not nullable String): not nullable String
static String! TrimTrailingDirectorySeparator(String! aPath)
static func TrimTrailingDirectorySeparator(_ aPath: String) -> String
static String TrimTrailingDirectorySeparator(String aPath)
Shared Function TrimTrailingDirectorySeparator(aPath As String) As String
Parameters:
- aPath: