GrayLib::cInstallDir Class Reference

#include <cInstallDir.h>

Public Member Functions
	cInstallDir (void)
	~cInstallDir (void)
bool	isInstallValid () const
cStringF	get_InstallDir () const
HRESULT	put_InstallDir (cStringF sInstallDir)
bool	IsInInstall (const FILECHAR_t *pszPath) const
cStringF	MakeFilePath (cStringF sPath) const
cStringF	MakeRelativePath (const FILECHAR_t *pszFullPath) const

Static Public Member Functions
static cStringF GRAYCALL	GetDefaultInstallDirBase ()
static bool GRAYCALL	IsInstallDirRestricted (const FILECHAR_t *pszName)

Protected Attributes
bool	m_bInstallValid
	The install has actually placed at least one file. More...
cStringF	m_sInstallDir
	main common data directory. More...

Detailed Description

Base/default/root path for some set of installed files. (on local hard disk) Acts sort of like the current directory. Allow the install to have optional branches/modules. Allow the branches to be renamed and redirected, aliased. Convert from a resource name to a full file path name.

Note

May be used with cManifestDir or cSyncDir.

Constructor & Destructor Documentation

cInstallDir()

GrayLib::cInstallDir::cInstallDir

(

void

)

~cInstallDir()

GrayLib::cInstallDir::~cInstallDir

(

void

)

Member Function Documentation

get_InstallDir()

cStringF GrayLib::cInstallDir::get_InstallDir ( ) const

inline

GetDefaultInstallDirBase()

cStringF GrayLib::cInstallDir::GetDefaultInstallDirBase ( )

static

get the default base directory where files might be installed for this machine. NOT specific to this App. _WIN32 = "Program Files"

IsInInstall()

bool GrayLib::cInstallDir::IsInInstall

(

const FILECHAR_t *

pszPath

)

const

is pszPath in the m_sInstallDir ? Assume it is if not rooted.

IsInstallDirRestricted()

bool GrayLib::cInstallDir::IsInstallDirRestricted ( const FILECHAR_t *  pszName )

static

is this an invalid install dir? I can't install into root system directories, Temporary areas etc.

Returns

true = BAD

isInstallValid()

bool GrayLib::cInstallDir::isInstallValid ( ) const

inline

MakeFilePath()

cStringF GrayLib::cInstallDir::MakeFilePath

(

cStringF

sPath

)

const

Given a relative resource file name. Make the full path to the file.

MakeRelativePath()

cStringF GrayLib::cInstallDir::MakeRelativePath ( const FILECHAR_t *  pszFullPath ) const

inline

Given a full path, get a path relative to the m_sInstallDir root (if possible) else return full path.

put_InstallDir()

HRESULT GrayLib::cInstallDir::put_InstallDir

(

cStringF

sInstallDir

)

Set the base data directory for map and resource files.

Returns

false = BAD

Member Data Documentation

m_bInstallValid

bool GrayLib::cInstallDir::m_bInstallValid

protected

The install has actually placed at least one file.

m_sInstallDir

cStringF GrayLib::cInstallDir::m_sInstallDir

protected

main common data directory.

---

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

• c:/Dennis/Source/Gray/GrayLib/include/FileSys/cInstallDir.h
• c:/Dennis/Source/Gray/GrayLib/src/FileSys/cInstallDir.cpp