Utilities

Detailed Description

Classes
class	DirectoryIterator
	Gets a directory items content. More...

Functions
bool	DeleteFile (PCChar8 filename)
	Deletes the file described by filename. More...
bool	RenameFile (PCChar8 filename, PCChar8 newFilename)
	Rename file. More...
bool	CreateDirectory (PCChar8 directoryName)
	Creates a directory. More...
String	ExtractFileName (PCChar8 FilePath)
	Extracts the file name described in FilePath. More...
String	ExtractFilePath (PCChar8 FilePath)
	Extracts the file path described in FilePath. More...
void	SplitFileName (const String FilePath, String &Path, String &FileName, String &FileExtension)
	Splits a file path into path, file name and file extension. More...
String	ChangeFileExt (PCChar8 FilePath, PCChar8 NewExt)
	Change file extension. More...
bool	IsAbsoluteFilePath (PCChar8 FilePath)
	Query if is it an absolute file path. More...
bool	IsRelativeFilePath (PCChar8 FilePath)
	Query if is it a relative file path. More...
String	AppendTrailingPathSeparator (PCChar8 FilePath)
	Appends a trailing path separator. More...
String	RemoveTrailingPathSeparator (PCChar8 FilePath)
	Removes the trailing path separator. More...
bool	CreateDirectoryPath (PCChar8 directoryPath)
	Creates a directory path. Create all hierachical directories contained in the given directory path. More...

Modules
	IsFileExist

Function Documentation

String AppendTrailingPathSeparator

(

PCChar8

FilePath

)

Appends a trailing path separator.

Parameters

FilePath

Full path of the file.

Returns

The result file path with separator.

String ChangeFileExt	(	PCChar8	FilePath,
		PCChar8	NewExt
	)

Change file extension.

Parameters

FilePath	Full path of the file.
NewExt	The new extension.

Returns

The result file path with new extension.

bool CreateDirectory

(

PCChar8

directoryName

)

Creates a directory.

Parameters

directoryName

Pathname of the directory.

Returns

true if success, false if not.

Warning

Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

bool CreateDirectoryPath

(

PCChar8

directoryPath

)

Creates a directory path. Create all hierachical directories contained in the given directory path.

Parameters

directoryPath

Directory path.

Returns

true if it succeeds, false if it fails.

bool DeleteFile

(

PCChar8

filename

)

Deletes the file described by filename.

Parameters

filename

Filename of the file.

Returns

true if success, false if not.

Warning

Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

String ExtractFileName

(

PCChar8

FilePath

)

Extracts the file name described in FilePath.

Parameters

FilePath

Full path of the file.

Returns

The file name

String ExtractFilePath

(

PCChar8

FilePath

)

Extracts the file path described in FilePath.

Parameters

FilePath

Full path of the file.

Returns

The file path

bool IsAbsoluteFilePath

(

PCChar8

FilePath

)

Query if is it an absolute file path.

Parameters

FilePath

Full path of the file.

Returns

true if it is, false if it isn't.

bool IsRelativeFilePath

(

PCChar8

FilePath

)

Query if is it a relative file path.

Parameters

FilePath

Full path of the file.

Returns

true if it is, false if it isn't.

String RemoveTrailingPathSeparator

(

PCChar8

FilePath

)

Removes the trailing path separator.

Parameters

FilePath

Full path of the file.

Returns

The result file path without separator.

bool RenameFile	(	PCChar8	filename,
		PCChar8	newFilename
	)

Rename file.

Parameters

filename	File name of the file.
newFilename	new file name .

Returns

true if success, false if not.

Warning

Non-Deterministic. Determinism when using ConceptRT library can be ensure by using Context Time Critical mechanisms.

void SplitFileName	(	const String	FilePath,
		String &	Path,
		String &	FileName,
		String &	FileExtension
	)

Splits a file path into path, file name and file extension.

Parameters

FilePath	Full path of the file.
Path	[in,out] Result path of the file.
FileName	[in,out] Result file name only.
FileExtension	[in,out] Result file extension.