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

 

ChangeExtension (not nullable String, String): not nullable String  virtual Cooper, Toffee

Change the extension of this file to something else. Pass an empty string to remove the extension.

 

static func ChangeExtension(_ aFileName: String, _ NewExtension: String) -> String

 

static String! ChangeExtension(String! aFileName, String NewExtension)

Parameters:

  • aFileName:
  • NewExtension:

ChangeExtension (not nullable String, nullable String): not nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

Change the extension of this file to something else. Pass an empty string to remove the extension.

 

class method ChangeExtension(aFileName: not nullable String; NewExtension: nullable String): not nullable String

 

static String! ChangeExtension(String! aFileName, String? NewExtension)

 

static func ChangeExtension(_ aFileName: String, _ NewExtension: String?) -> String

Parameters:

  • aFileName:
  • NewExtension:

Combine (String, array of String): String  virtual Cooper, Toffee

Append multiple paths together, using the directory seperator to bind them.

 

static func Combine(_ aBasePath: String, _ aPaths: String...) -> String

 

static String Combine(String aBasePath, String[]... aPaths)

Parameters:

  • aBasePath:
  • aPaths:

Combine (nullable String, array of String): nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

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)

 

static func Combine(_ aBasePath: String?, _ aPaths: String...) -> 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)

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)

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; }

ExpandTildeInPath Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-UIKit for Mac-x86_64, 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 ~

 

class method ExpandTildeInPath(aPath: not nullable String): not nullable String

 

static String! ExpandTildeInPath(String! aPath)

 

static func ExpandTildeInPath(_ aPath: String) -> 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)

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)

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)

Parameters:

  • aFileName:

GetFullPath .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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)

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)

Parameters:

  • aFileName:

GetParentDirectory (not nullable String) FolderSeparator(Char): nullable String

 

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)

Parameters:

  • aFileName:
  • aFolderSeparator:

GetParentDirectory (not nullable String): nullable String

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)

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)

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)

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)

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)

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)

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)

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)

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)

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; }

 

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; }

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; }

 

ChangeExtension (not nullable String, String): not nullable String  virtual Cooper, Toffee

Change the extension of this file to something else. Pass an empty string to remove the extension.

 

static func ChangeExtension(_ aFileName: String, _ NewExtension: String) -> String

 

static String! ChangeExtension(String! aFileName, String NewExtension)

Parameters:

  • aFileName:
  • NewExtension:

ChangeExtension (not nullable String, nullable String): not nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

Change the extension of this file to something else. Pass an empty string to remove the extension.

 

class method ChangeExtension(aFileName: not nullable String; NewExtension: nullable String): not nullable String

 

static String! ChangeExtension(String! aFileName, String? NewExtension)

 

static func ChangeExtension(_ aFileName: String, _ NewExtension: String?) -> String

Parameters:

  • aFileName:
  • NewExtension:

Combine (String, array of String): String  virtual Cooper, Toffee

Append multiple paths together, using the directory seperator to bind them.

 

static func Combine(_ aBasePath: String, _ aPaths: String...) -> String

 

static String Combine(String aBasePath, String[]... aPaths)

Parameters:

  • aBasePath:
  • aPaths:

Combine (nullable String, array of String): nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

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)

 

static func Combine(_ aBasePath: String?, _ aPaths: String...) -> 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)

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)

Parameters:

  • aBasePath:
  • aPaths:

ExpandTildeInPath Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-UIKit for Mac-x86_64, 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 ~

 

class method ExpandTildeInPath(aPath: not nullable String): not nullable String

 

static String! ExpandTildeInPath(String! aPath)

 

static func ExpandTildeInPath(_ aPath: String) -> 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)

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)

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)

Parameters:

  • aFileName:

GetFullPath .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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)

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)

Parameters:

  • aFileName:

GetParentDirectory (not nullable String) FolderSeparator(Char): nullable String

 

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)

Parameters:

  • aFileName:
  • aFolderSeparator:

GetParentDirectory (not nullable String): nullable String

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)

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)

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)

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)

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)

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)

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)

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)

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)

Parameters:

  • aFileName: