namespace Geo PathUtils

This is the documentation for Enlighten.

namespace Geo PathUtils

Geo::PathUtils

Functions to handle file path creation and modification.

Functions

Name

Description

Name

Description

AppendFileSeparator(GeoFileString &)

This will append a \ (or /) to the end of the string if one isn't already there.

Canonicalize(const char *)

This will standardise a filename to the appropriate platform.

Canonicalize(const Geo::GeoFileString &)

This will standardise a filename to the appropriate platform.

CropAfterFileExtension(GeoFileString &)

This will remove the string beyond and including the last .

CropAfterLastFileSeparator(GeoFileString &)

This will remove the string beyond and including the last file separator if there is one.

CropBeforeFileExtension(GeoFileString &)

This will remove the string upto and including the last .

CropBeforeLastFileSeparator(GeoFileString &)

This will remove the string up to and including the last file separator if there is one.

ExtractArguments(GeoFileString, GeoArray< GeoFileString >)

This function breaks arguments up into tokens and handles filenames with spaces by using quotes.

ExtractDirectories(const GeoFileString &, GeoFileString)

Splits a given path into an array of directory names.

GetApplicationPath()

Returns the path to the application being executed. May not be available outside Windows platform.

GetCurrentPath()

Returns the current working folder. May not be available outside Windows platform.

GetDirectoryName(const GeoFileString &)

This will remove the string beyond and including the last file separator if there is one.

GetDriveName(const GeoFileString &)

Extracts the drive letter of a given path. Valid only on platforms with multiple filesystem roots.

GetEnvString(const char *)

Retrieves the value of an Environment variable. May not be available outside Windows platform.

GetFileName(const GeoFileString &)

This will remove the string before and including the last file separator if there is one.

GetFileNameWithoutExtension(const GeoFileString &)

This will remove the string before and including the last file separator if there is one.

GetSandboxDataPath()

Returns the path to the application's data path, for platforms that provide application sandboxes.

GetTemporaryPath()

Returns the temporary folder (e.g. C:\Windows\Temp). May not be available outside Windows platform.

GetWindowsPath()

Returns the path to the Windows folder. Not available outside Windows platform.

IsAbsoluteFilePath(const char *)

Returns the true if file string is an absolute path to a file, and false if it is relative.

MakePathRelative(GeoFileString &, const GeoFileString &)

Make path relative wrt.

NormalizeFileSeparators(GeoFileString &, char)

This will normalize file separators to the system default, or the given slash character if provided.

RemoveTrailingFileSeparators(GeoFileString &)

This will remove \ (or /) characters from the end of the string if present.

SetSandboxDataPath(const char *)

Sets the path to the application's data path, for platforms that provide application sandboxes.



bool Geo::PathUtils::AppendFileSeparator


public: bool AppendFileSeparator
(
    GeoFileString & path
)


This will append a \ (or /) to the end of the string if one isn't already there.



GeoFileString Geo::PathUtils::Canonicalize


public: GeoFileString Canonicalize
(
    const char * in
)