Directory Class Reference

Common directory functions. More...

#include <directory.hpp>

Static Public Member Functions
static filesystem::path	getDataPath (bool isShared=false)
	Returns application data directory. (MT-Safe)
static filesystem::path	getAppDataPath (const string &appName, bool isShared=false)
	Returns application data directory + name. (MT-Safe)
static filesystem::path	getResourcesPath ()
	Returns bundled resources directory. (MT-Safe)

Detailed Description

Common directory functions.

See the directory.h

Member Function Documentation

getDataPath()

static filesystem::path getDataPath ( bool isShared = false )

inlinestatic

Returns application data directory. (MT-Safe)

See the getDataDirectory().

Parameters

isShared

is data directory shared between multiple users

Returns

Data directory path on success.

Exceptions

Error

if failed to get data directory.

getAppDataPath()

static filesystem::path getAppDataPath ( const string & appName, bool isShared = false )

inlinestatic

Returns application data directory + name. (MT-Safe)

See the getAppDataDirectory().

Parameters

appName	target application name string
isShared	is data directory shared between multiple users

Returns

Data directory path on success.

Exceptions

Error

if failed to get app data directory.

getResourcesPath()

static filesystem::path getResourcesPath ( )

inlinestatic

Returns bundled resources directory. (MT-Safe)

See the getResourcesDirectory().

Returns

Resources directory path on success.

Exceptions

Error

if failed to get resources directory.