File system related functions More...

Static Public Member Functions
static string	GetName (string path)
	Get filename without leading directory path. More...

static string	GetExtension (string path)
	Get filename extension. Will return with suffix like ".xml" except for names starting with dot like ".gitignore" where function will result with empty string. More...

static string	GetRoot (string path)
	Get file root path. Works also with UNC and protocol paths. More...

static string	GetDirectory (string path)
	Get directory name from file path. Returns path itself if it looks like directory. More...

static string	GetNameWithoutExtension (string path)
	Get filename without extension. More...

static string	IncludeTrailingPathSeparator (string path)
	Include traling path directory separator if needed More...

static string	ExcludeRoot (string path)
	Exclude leading path root. More...

static string	IncludeLeadingRoot (string path, string root)
	Include leading root directory to the path if not specified More...

static string	ExcludeTrailingPathSeparator (string path)
	Exclude traling path directory separator More...

static string	FileUniqueIdentity (string file, string path, bool reserve)
	Return unique name for file by checking it's not exists. This method may create empty file if reserve option is set true and it is More...

static string	FileUniqueIdentity (string file, string path)
	Return unique name for file More...

static string	FileUniqueIdentity (string file, bool reserve)
	Return unique name for file More...

static string	FileUniqueIdentity (string file)
	Return unique name for file More...

static bool	HasNoExtension (string file)
	Return true if file name does not contain extension More...

static bool	IsDirectory (string file)
	Check if path is directory More...

static string	GetAbsolutePath (string file)
	Get absolute path More...

static string	GetAbsolutePath (string file, string current)
	Get absolute path More...

static bool	IsRelativePath (string path, string[] separator)
	Check if file or directory path is relative or absolute. More...

static bool	IsRelativePath (string path)
	Check if file or directory path is relative or absolute. More...

static string	Locate (string command)
	Locate executable file. More...

static string	Locate (string command, string[] search)
	Locate command file. More...

static string	Locate (string file, string[] search, string[] extension)
	Locate file with one of possible extensions in any directory and return full path to it. More...

static string	Locate (string file, string[] search, string[] extension, Energy.Enumeration.LocateBehaviour behaviour)
	Locate file with one of possible extensions in any directory and return full path to it. More...

static bool	MakeDirectory (string path)
	Create directory if not exists More...

static bool	RemoveDirectory (string path, bool recursive)
	Remove directory if exists More...

static bool	RemoveDirectory (string path)
	Remove directory if exists and is empty More...

Detailed Description

File system related functions

Member Function Documentation

◆ ExcludeRoot()

static string Energy.Base.File.ExcludeRoot ( string path )

static

Exclude leading path root.

Parameters

path

Returns

◆ ExcludeTrailingPathSeparator()

static string Energy.Base.File.ExcludeTrailingPathSeparator ( string path )

static

Exclude traling path directory separator

Parameters

path string

Returns: string

◆ FileUniqueIdentity() [1/4]

static string Energy.Base.File.FileUniqueIdentity	(	string	file,
		string	path,
		bool	reserve
	)

static

Return unique name for file by checking it's not exists. This method may create empty file if reserve option is set true and it is

Parameters

file	string
path	string
reserve	bool

Returns: string

◆ FileUniqueIdentity() [2/4]

static string Energy.Base.File.FileUniqueIdentity	(	string	file,
		string	path
	)

static

Return unique name for file

Parameters

file	string
path	string

Returns: string

◆ FileUniqueIdentity() [3/4]

static string Energy.Base.File.FileUniqueIdentity	(	string	file,
		bool	reserve
	)

static

Return unique name for file

Parameters

file	string
reserve	bool

Returns: string

◆ FileUniqueIdentity() [4/4]

static string Energy.Base.File.FileUniqueIdentity ( string file )

static

Return unique name for file

Parameters

file string

Returns: string

◆ GetAbsolutePath() [1/2]

static string Energy.Base.File.GetAbsolutePath ( string file )

static

Get absolute path

Parameters

file string

Returns: string

◆ GetAbsolutePath() [2/2]

static string Energy.Base.File.GetAbsolutePath	(	string	file,
		string	current
	)

static

Get absolute path

Parameters

file	string
current	string

Returns: string

◆ GetDirectory()

static string Energy.Base.File.GetDirectory ( string path )

static

Get directory name from file path. Returns path itself if it looks like directory.

Parameters

path File path

Returns: Directory name

◆ GetExtension()

static string Energy.Base.File.GetExtension ( string path )

static

Get filename extension. Will return with suffix like ".xml" except for names starting with dot like ".gitignore" where function will result with empty string.

Parameters

path

Returns

◆ GetName()

static string Energy.Base.File.GetName ( string path )

static

Get filename without leading directory path.

Parameters

path

Returns

◆ GetNameWithoutExtension()

static string Energy.Base.File.GetNameWithoutExtension ( string path )

static

Get filename without extension.

Parameters

path

Returns

◆ GetRoot()

static string Energy.Base.File.GetRoot ( string path )

static

Get file root path. Works also with UNC and protocol paths.

Parameters

path

Returns

◆ HasNoExtension()

static bool Energy.Base.File.HasNoExtension ( string file )

static

Return true if file name does not contain extension

Parameters

file

Returns

◆ IncludeLeadingRoot()

static string Energy.Base.File.IncludeLeadingRoot	(	string	path,
		string	root
	)

static

Include leading root directory to the path if not specified

Parameters

path	string
root	string

Returns: string

◆ IncludeTrailingPathSeparator()

static string Energy.Base.File.IncludeTrailingPathSeparator ( string path )

static

Include traling path directory separator if needed

Parameters

path string

Returns: string

◆ IsDirectory()

static bool Energy.Base.File.IsDirectory ( string file )

static

Check if path is directory

Parameters

file string

Returns: bool

◆ IsRelativePath() [1/2]

static bool Energy.Base.File.IsRelativePath	(	string	path,
		string []	separator
	)

static

Check if file or directory path is relative or absolute.

Parameters

path	string
separator	Separator list

Returns: bool

◆ IsRelativePath() [2/2]

static bool Energy.Base.File.IsRelativePath ( string path )

static

Check if file or directory path is relative or absolute.

Parameters

path string

Returns: bool

◆ Locate() [1/4]

static string Energy.Base.File.Locate ( string command )

static

Locate executable file.

Parameters

command string

Returns: string

◆ Locate() [2/4]

static string Energy.Base.File.Locate	(	string	command,
		string []	search
	)

static

Locate command file.

Parameters

command	string
search	string[]

Returns: string

◆ Locate() [3/4]

static string Energy.Base.File.Locate	(	string	file,
		string []	search,
		string []	extension
	)

static

Locate file with one of possible extensions in any directory and return full path to it.

Parameters

file	File name with or without extension and leading path
search	Directory search list
extension	List of filename extensions to check (i.e. ".txt", "ini", ".")

Returns: Empty string if file not found or full path to found one

◆ Locate() [4/4]

static string Energy.Base.File.Locate	(	string	file,
		string []	search,
		string []	extension,
		Energy.Enumeration.LocateBehaviour	behaviour
	)

static

Locate file with one of possible extensions in any directory and return full path to it.

Parameters

file	File name with or without extension and leading path
search	Directory search list
extension	List of filename extensions to check (i.e. ".txt", "ini", ".")
behaviour	Lookup behaviour (iterate over directories or extensions)

Returns: Empty string if file not found or full path to found one

◆ MakeDirectory()

static bool Energy.Base.File.MakeDirectory ( string path )

static

Create directory if not exists

Parameters

path

Returns: True if directory exists or was created

◆ RemoveDirectory() [1/2]

static bool Energy.Base.File.RemoveDirectory	(	string	path,
		bool	recursive
	)

static

Remove directory if exists

Parameters

path
recursive

Returns: True if directory was removed or not exists

◆ RemoveDirectory() [2/2]

static bool Energy.Base.File.RemoveDirectory ( string path )

static

Remove directory if exists and is empty

Parameters

path

Returns: True if directory was removed or not exists

The documentation for this class was generated from the following file:

File.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ExcludeRoot()

◆ ExcludeTrailingPathSeparator()

◆ FileUniqueIdentity() [1/4]

◆ FileUniqueIdentity() [2/4]

◆ FileUniqueIdentity() [3/4]

◆ FileUniqueIdentity() [4/4]

◆ GetAbsolutePath() [1/2]

◆ GetAbsolutePath() [2/2]

◆ GetDirectory()

◆ GetExtension()

◆ GetName()

◆ GetNameWithoutExtension()

◆ GetRoot()

◆ HasNoExtension()

◆ IncludeLeadingRoot()

◆ IncludeTrailingPathSeparator()

◆ IsDirectory()

◆ IsRelativePath() [1/2]

◆ IsRelativePath() [2/2]

◆ Locate() [1/4]

◆ Locate() [2/4]

◆ Locate() [3/4]

◆ Locate() [4/4]

◆ MakeDirectory()

◆ RemoveDirectory() [1/2]

◆ RemoveDirectory() [2/2]