WindowsFileSystem Struct Reference

#include <Win32FileSystem.hpp>

Inheritance diagram for WindowsFileSystem:

Static Public Member Functions
static WindowsFile *	OpenFile (const FileOpenAttribs &OpenAttribs)
static Diligent::Char	GetSlashSymbol ()
static bool	FileExists (const Diligent::Char *strFilePath)
static bool	PathExists (const Diligent::Char *strPath)
static bool	CreateDirectory (const Diligent::Char *strPath)
static void	ClearDirectory (const Diligent::Char *strPath, bool Recursive=false)
static void	DeleteFile (const Diligent::Char *strPath)
static void	DeleteDirectory (const Diligent::Char *strPath)
static bool	IsDirectory (const Diligent::Char *strPath)
static std::vector< std::unique_ptr< FindFileData > >	Search (const Diligent::Char *SearchPattern)
static std::string	FileDialog (const FileDialogAttribs &DialogAttribs)
static std::string	GetCurrentDirectory ()
static bool	GetRelativePath (const Diligent::Char *strPathFrom, bool IsFromDirectory, const Diligent::Char *strPathTo, bool IsToDirectory, std::string &RelativePath)
	Returns a relative path from one file or folder to another. More...
Static Public Member Functions inherited from BasicFileSystem
static BasicFile *	OpenFile (FileOpenAttribs &OpenAttribs)
static void	ReleaseFile (BasicFile *)
static std::string	GetFullPath (const Diligent::Char *strFilePath)
static bool	FileExists (const Diligent::Char *strFilePath)
static void	SetWorkingDirectory (const Diligent::Char *strWorkingDir)
static const Diligent::String &	GetWorkingDirectory ()
static Diligent::Char	GetSlashSymbol ()
static void	CorrectSlashes (Diligent::String &Path, Diligent::Char SlashSymbol)
static void	SplitFilePath (const Diligent::String &FullName, Diligent::String *Path, Diligent::String *Name)
static bool	IsPathAbsolute (const Diligent::Char *strPath)

Additional Inherited Members
Static Protected Attributes inherited from BasicFileSystem
static Diligent::String	m_strWorkingDirectory

Member Function Documentation

ClearDirectory()

void WindowsFileSystem::ClearDirectory ( const Diligent::Char *  strPath, bool  Recursive = false  )

static

CreateDirectory()

bool WindowsFileSystem::CreateDirectory ( const Diligent::Char *  strPath )

static

DeleteDirectory()

void WindowsFileSystem::DeleteDirectory ( const Diligent::Char *  strPath )

static

DeleteFile()

void WindowsFileSystem::DeleteFile ( const Diligent::Char *  strPath )

static

FileDialog()

std::string WindowsFileSystem::FileDialog ( const FileDialogAttribs &  DialogAttribs )

static

FileExists()

bool WindowsFileSystem::FileExists ( const Diligent::Char *  strFilePath )

static

GetCurrentDirectory()

std::string WindowsFileSystem::GetCurrentDirectory ( )

static

GetRelativePath()

bool WindowsFileSystem::GetRelativePath ( const Diligent::Char *  strPathFrom, bool  IsFromDirectory, const Diligent::Char *  strPathTo, bool  IsToDirectory, std::string &  RelativePath  )

static

Returns a relative path from one file or folder to another.

Parameters

[in]	strPathFrom	- Path that defines the start of the relative path. If this parameter is null, current directory will be used.
[in]	IsFromDirectory	- Indicates if strPathFrom is a directory. Ignored if strPathFrom is null (in which case current directory is used).
[in]	strPathTo	- Path that defines the endpoint of the relative path. This parameter must not be null.
[in]	IsToDirectory	- Indicates if strPathTo is a directory.
[out]	RelativePath	- Relative path from strPathFrom to strPathTo. If no relative path exists, strPathFrom will be returned.

Returns

true if the relative path exists (i.e. strPathFrom and strPathTo have a common prefix), and false otherwise.

GetSlashSymbol()

static Diligent::Char WindowsFileSystem::GetSlashSymbol ( )

inlinestatic

IsDirectory()

bool WindowsFileSystem::IsDirectory ( const Diligent::Char *  strPath )

static

OpenFile()

WindowsFile * WindowsFileSystem::OpenFile ( const FileOpenAttribs &  OpenAttribs )

static

PathExists()

bool WindowsFileSystem::PathExists ( const Diligent::Char *  strPath )

static

Search()

std::vector< std::unique_ptr< FindFileData > > WindowsFileSystem::Search ( const Diligent::Char *  SearchPattern )

static

---

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

• Platforms/Win32/interface/Win32FileSystem.hpp
• Platforms/Win32/src/Win32FileSystem.cpp