Path
Overview
Filesystem related utilities.
Location
-
Reference:
- Elements.dll .NET, .NET Standard 2.0
- elements.jar Cooper
- Elements.fx Island, ToffeeV2
- libElements.fx Toffee
- Namespace: RemObjects.Elements.RTL
- Platforms: .NET, .NET Standard 2.0, Cooper, Island, Toffee, ToffeeV2
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
Parameters:
- aFileName:
- aNewExtension:
Combine
Append multiple paths together, using the directory seperator to bind them.
Parameters:
- aBasePath:
- aPaths:
CombineUnixPath
Append multiple paths together, using the unix directory seperator to bind them.
Parameters:
- aBasePath:
- aPaths:
CombineWindowsPath
Append multiple paths together, using the windows directory seperator to bind them.
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, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator, Toffee, ToffeeV2
Expand a ~/ path to the users real home directory. Does nothing with the string if does not start with ~
Parameters:
- aPath:
FirstMatchingSubfolder (String, IEnumerable<String>): nullable String .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: 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?
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
FirstMatchingSubfolder (String, IEnumerable<String>, Block): nullable String ToffeeV2
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: IEnumerable<String>, _ aBuildPath: Block) -> String?
Parameters:
- aFolder:
- aSubFolderOptions:
- aBuildPath:
FirstMatchingSubfolder (String, IEnumerable<String>, Func<String, String, String>): nullable String virtual .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee
// .NET, .NET Standard 2.0
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: IEnumerable<String>; aBuildPath: Func<String, String, String>): nullable String
// Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: IEnumerable<String>; aBuildPath: Func<RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String>): nullable String
// .NET, .NET Standard 2.0
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String> aSubFolderOptions, Func<String, String, String> aBuildPath)
// Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String> aSubFolderOptions, Func<RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String> aBuildPath)
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: INSFastEnumeration<String>, _ aBuildPath: (String, String) -> String) -> String
static String FirstMatchingSubfolder(String aFolder, Iterable<String> aSubFolderOptions, Func3<String, String, String> aBuildPath)
// .NET, .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, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>, aBuildPath As Func<RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
- aBuildPath:
GetExtension
Returns the extension, including the .
Parameters:
- aFileName:
GetFileName
Returns the filename of a file, without the directory.
Parameters:
- aFileName:
GetFileNameWithoutExtension
Returns the filename of a file, without the directory or extension.
Parameters:
- aFileName:
GetFullPath .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
Returns the full path name, expanding any relative or .. / . paths.
Parameters:
- RelativePath:
GetNetworkServerName
Returns the network path used in a path; returns nothing if it's not a network path.
Parameters:
- aFileName:
class method GetParentDirectory(aFileName: not nullable String) FolderSeparator(aFolderSeparator: Char): nullable String
Parameters:
- aFileName:
- aFolderSeparator:
Returns the parent directory for a file or directory.
Parameters:
- aFileName:
GetPath
Resolves a path, relative to another path.
class method GetPath(aFullPath: not nullable String) RelativeToPath(aBasePath: not nullable String): nullable String
Parameters:
- aFullPath:
- aBasePath:
GetPathWithoutExtension
Returns a filename using the unix file seperator.
Parameters:
- aFileName:
GetUnixFileName
Returns a file as unix filename.
Parameters:
- aFileName:
GetUnixFileNameWithoutExtension
Returns a file as unix filename without extension.
Parameters:
- aFileName:
GetUnixParentDirectory
Returns the parent directory of a unix plath.
Parameters:
- aFileName:
GetWindowsFileName
Returns a filename using the windows file seperator.
Parameters:
- aFileName:
GetWindowsFileNameWithoutExtension
Returns a file as Windows filename without extension.
Parameters:
- aFileName:
GetWindowsParentDirectory
Returns the parent directory of a windows path.
Parameters:
- aFileName:
PathListSeparatorChar
Separator characters for summing up multiple paths; generally ; or :.
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 :.
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
Parameters:
- aFileName:
- aNewExtension:
Combine
Append multiple paths together, using the directory seperator to bind them.
Parameters:
- aBasePath:
- aPaths:
CombineUnixPath
Append multiple paths together, using the unix directory seperator to bind them.
Parameters:
- aBasePath:
- aPaths:
CombineWindowsPath
Append multiple paths together, using the windows directory seperator to bind them.
Parameters:
- aBasePath:
- aPaths:
ExpandTildeInPath Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator, Toffee, ToffeeV2
Expand a ~/ path to the users real home directory. Does nothing with the string if does not start with ~
Parameters:
- aPath:
FirstMatchingSubfolder (String, IEnumerable<String>): nullable String .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: 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?
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
FirstMatchingSubfolder (String, IEnumerable<String>, Block): nullable String ToffeeV2
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: IEnumerable<String>, _ aBuildPath: Block) -> String?
Parameters:
- aFolder:
- aSubFolderOptions:
- aBuildPath:
FirstMatchingSubfolder (String, IEnumerable<String>, Func<String, String, String>): nullable String virtual .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee
// .NET, .NET Standard 2.0
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: IEnumerable<String>; aBuildPath: Func<String, String, String>): nullable String
// Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
class method FirstMatchingSubfolder(aFolder: String; aSubFolderOptions: IEnumerable<String>; aBuildPath: Func<RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String>): nullable String
// .NET, .NET Standard 2.0
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String> aSubFolderOptions, Func<String, String, String> aBuildPath)
// Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
static String? FirstMatchingSubfolder(String aFolder, IEnumerable<String> aSubFolderOptions, Func<RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String> aBuildPath)
static func FirstMatchingSubfolder(_ aFolder: String, _ aSubFolderOptions: INSFastEnumeration<String>, _ aBuildPath: (String, String) -> String) -> String
static String FirstMatchingSubfolder(String aFolder, Iterable<String> aSubFolderOptions, Func3<String, String, String> aBuildPath)
// .NET, .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, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows
Shared Function FirstMatchingSubfolder(aFolder As String, aSubFolderOptions As IEnumerable<String>, aBuildPath As Func<RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String,RemObjects.Elements.RTL.String>) As String?
Parameters:
- aFolder:
- aSubFolderOptions:
- aBuildPath:
GetExtension
Returns the extension, including the .
Parameters:
- aFileName:
GetFileName
Returns the filename of a file, without the directory.
Parameters:
- aFileName:
GetFileNameWithoutExtension
Returns the filename of a file, without the directory or extension.
Parameters:
- aFileName:
GetFullPath .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
Returns the full path name, expanding any relative or .. / . paths.
Parameters:
- RelativePath:
GetNetworkServerName
Returns the network path used in a path; returns nothing if it's not a network path.
Parameters:
- aFileName:
class method GetParentDirectory(aFileName: not nullable String) FolderSeparator(aFolderSeparator: Char): nullable String
Parameters:
- aFileName:
- aFolderSeparator:
Returns the parent directory for a file or directory.
Parameters:
- aFileName:
GetPath
Resolves a path, relative to another path.
class method GetPath(aFullPath: not nullable String) RelativeToPath(aBasePath: not nullable String): nullable String
Parameters:
- aFullPath:
- aBasePath:
GetPathWithoutExtension
Returns a filename using the unix file seperator.
Parameters:
- aFileName:
GetUnixFileName
Returns a file as unix filename.
Parameters:
- aFileName:
GetUnixFileNameWithoutExtension
Returns a file as unix filename without extension.
Parameters:
- aFileName:
GetUnixParentDirectory
Returns the parent directory of a unix plath.
Parameters:
- aFileName:
GetWindowsFileName
Returns a filename using the windows file seperator.
Parameters:
- aFileName:
GetWindowsFileNameWithoutExtension
Returns a file as Windows filename without extension.
Parameters:
- aFileName:
GetWindowsParentDirectory
Returns the parent directory of a windows path.
Parameters:
- aFileName: