A path manipulation helper class. More...

#include <epath.h>

Static Public Member Functions
static cpStr	getDirectorySeparatorString ()
	Retrieves the directory separator string. More...

static cChar	getDirectorySeparatorChar ()
	Retrieves the directory separator character. More...

static cChar	getAltDirectorySeparatorChar ()
	Retrieves the alternate directory separator character. More...

static cChar	getVolumeSeparatorChar ()
	Retrieves the volume separator character. More...

static cpStr	getPathSeparatorChars ()
	Retrieves the path separator characters. More...

static cpStr	getInvalidPathChars ()
	Retrieves the invalid path characters. More...

static cpStr	getInvalidFileNameChars ()
	Retrieves the invalid file name characters. More...

static Void	changeExtension (cpStr path, cpStr extension, EString &newPath)
	Changes the extension of an exist path name. More...

static Void	combine (cpStr path1, cpStr path2, cpStr path3, cpStr path4, EString &path)
	Combines individual path names into a single path name. More...

static Void	combine (cpStr path1, cpStr path2, cpStr path3, EString &path)
	Combines individual path names into a single path name. More...

static Void	combine (cpStr path1, cpStr path2, EString &path)
	Combines individual path names into a single path name. More...

static EString	combine (cpStr path1, cpStr path2, cpStr path3, cpStr path4)
	Combines individual path names into a single path name. More...

static EString	combine (cpStr path1, cpStr path2, cpStr path3)
	Combines individual path names into a single path name. More...

static EString	combine (cpStr path1, cpStr path2)
	Combines individual path names into a single path name. More...

static Void	getDirectoryName (cpStr path, EString &dirName)
	Retrieves the directory name from a file name. More...

static Void	getExtension (cpStr path, EString &ext)
	Retrieves the extension of a file name. More...

static Void	getFileName (cpStr path, EString &fileName)
	Retrieves just the file name from a fully qualified file name. More...

static Void	getFileNameWithoutExtension (cpStr path, EString &fileName)
	Retrieves the file name without any extension. More...

static Void	getPathRoot (cpStr path, EString &root)
	Retrieves the path root. More...

static EString	getDirectoryName (cpStr path)
	Retrieves the directory name from a file name. More...

static EString	getExtension (cpStr path)
	Retrieves the extension of a file name. More...

static EString	getFileName (cpStr path)
	Retrieves just the file name from a fully qualified file name. More...

static EString	getFileNameWithoutExtension (cpStr path)
	Retrieves the file name without any extension. More...

static EString	getPathRoot (cpStr path)
	Retrieves the path root. More...

Detailed Description

A path manipulation helper class.

Member Function Documentation

◆ changeExtension()

Void EPath::changeExtension	(	cpStr	path,
		cpStr	extension,
		EString &	newPath
	)

static

Changes the extension of an exist path name.

Parameters

path	the original path name.
extension	the new extension.
newPath	the new path name.

◆ combine() [1/6]

EString EPath::combine	(	cpStr	path1,
		cpStr	path2
	)

static

Combines individual path names into a single path name.

Parameters

path1	the first path name.
path2	the second path name.

Returns: the combined path name.

◆ combine() [2/6]

EString EPath::combine	(	cpStr	path1,
		cpStr	path2,
		cpStr	path3
	)

static

Combines individual path names into a single path name.

Parameters

path1	the first path name.
path2	the second path name.
path3	the third path name.

Returns: the combined path name.

◆ combine() [3/6]

EString EPath::combine	(	cpStr	path1,
		cpStr	path2,
		cpStr	path3,
		cpStr	path4
	)

static

Combines individual path names into a single path name.

Parameters

path1	the first path name.
path2	the second path name.
path3	the third path name.
path4	the fourth path name.

Returns: the combined path name.

◆ combine() [4/6]

Void EPath::combine	(	cpStr	path1,
		cpStr	path2,
		cpStr	path3,
		cpStr	path4,
		EString &	path
	)

static

Combines individual path names into a single path name.

Parameters

path1	the first path name.
path2	the second path name.
path3	the third path name.
path4	the fourth path name.
path	the combined path name.

◆ combine() [5/6]

Void EPath::combine	(	cpStr	path1,
		cpStr	path2,
		cpStr	path3,
		EString &	path
	)

static

Combines individual path names into a single path name.

Parameters

path1	the first path name.
path2	the second path name.
path3	the third path name.
path	the combined path name.

◆ combine() [6/6]

Void EPath::combine	(	cpStr	path1,
		cpStr	path2,
		EString &	path
	)

static

Combines individual path names into a single path name.

Parameters

path1	the first path name.
path2	the second path name.
path	the combined path name.

◆ getAltDirectorySeparatorChar()

static cChar EPath::getAltDirectorySeparatorChar ( )

static

Retrieves the alternate directory separator character.

Returns: the alternate directory separator character.

◆ getDirectoryName() [1/2]

static EString EPath::getDirectoryName ( cpStr path )

inlinestatic

Retrieves the directory name from a file name.

Parameters

path	the original file name.

Returns: the extracted directory name.

◆ getDirectoryName() [2/2]

Void EPath::getDirectoryName	(	cpStr	path,
		EString &	dirName
	)

static

Retrieves the directory name from a file name.

Parameters

path	the original file name.
dirName	the extracted directory name.

◆ getDirectorySeparatorChar()

static cChar EPath::getDirectorySeparatorChar ( )

static

Retrieves the directory separator character.

Returns: the directory separator character.

◆ getDirectorySeparatorString()

static cpStr EPath::getDirectorySeparatorString ( )

static

Retrieves the directory separator string.

Returns: the directory separator string.

◆ getExtension() [1/2]

static EString EPath::getExtension ( cpStr path )

inlinestatic

Retrieves the extension of a file name.

Parameters

path	the original file name.

Returns: the extracted file extension.

◆ getExtension() [2/2]

Void EPath::getExtension	(	cpStr	path,
		EString &	ext
	)

static

Retrieves the extension of a file name.

Parameters

path	the original file name.
ext	the extracted file extension.

◆ getFileName() [1/2]

static EString EPath::getFileName ( cpStr path )

inlinestatic

Retrieves just the file name from a fully qualified file name.

Parameters

path	the fully qualified file name.

Returns: the extracted file name.

◆ getFileName() [2/2]

Void EPath::getFileName	(	cpStr	path,
		EString &	fileName
	)

static

Retrieves just the file name from a fully qualified file name.

Parameters

path	the fully qualified file name.
fileName	the extracted file name.

◆ getFileNameWithoutExtension() [1/2]

static EString EPath::getFileNameWithoutExtension ( cpStr path )

inlinestatic

Retrieves the file name without any extension.

Parameters

path	the fully qualified file name.

Returns: the file name without any extension.

◆ getFileNameWithoutExtension() [2/2]

Void EPath::getFileNameWithoutExtension	(	cpStr	path,
		EString &	fileName
	)

static

Retrieves the file name without any extension.

Parameters

path	the fully qualified file name.
fileName	the file name without any extension.

◆ getInvalidFileNameChars()

static cpStr EPath::getInvalidFileNameChars ( )

static

Retrieves the invalid file name characters.

Returns: the invalid file name characters.

◆ getInvalidPathChars()

static cpStr EPath::getInvalidPathChars ( )

static

Retrieves the invalid path characters.

Returns: the invalid path characters.

◆ getPathRoot() [1/2]

static EString EPath::getPathRoot ( cpStr path )

inlinestatic

Retrieves the path root.

Parameters

path	the full path.

Returns: the path root.

◆ getPathRoot() [2/2]

Void EPath::getPathRoot	(	cpStr	path,
		EString &	root
	)

static

Retrieves the path root.

Parameters

path	the full path.
root	the path root.

◆ getPathSeparatorChars()

static cpStr EPath::getPathSeparatorChars ( )

static

Retrieves the path separator characters.

Returns: the path separator characters.

◆ getVolumeSeparatorChar()

static cChar EPath::getVolumeSeparatorChar ( )

static

Retrieves the volume separator character.

Returns: the volume separator character.

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

/home/vagrant/share/code/epctools/include/epc/epath.h
/home/vagrant/share/code/epctools/src/epath.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ changeExtension()

◆ combine() [1/6]

◆ combine() [2/6]

◆ combine() [3/6]

◆ combine() [4/6]

◆ combine() [5/6]

◆ combine() [6/6]

◆ getAltDirectorySeparatorChar()

◆ getDirectoryName() [1/2]

◆ getDirectoryName() [2/2]

◆ getDirectorySeparatorChar()

◆ getDirectorySeparatorString()

◆ getExtension() [1/2]

◆ getExtension() [2/2]

◆ getFileName() [1/2]

◆ getFileName() [2/2]

◆ getFileNameWithoutExtension() [1/2]

◆ getFileNameWithoutExtension() [2/2]

◆ getInvalidFileNameChars()

◆ getInvalidPathChars()

◆ getPathRoot() [1/2]

◆ getPathRoot() [2/2]

◆ getPathSeparatorChars()

◆ getVolumeSeparatorChar()