PLCore::Directory Class Reference

Class for accessing a directory within the file system. More...

#include <Directory.h>

Inheritance diagram for PLCore::Directory:

List of all members.

Public Member Functions
	Directory ()
	Constructor.
	Directory (const String &sUrl, const FileAccess *pAccess=nullptr)
	Constructor.
	Directory (const Url &cUrl, const FileAccess *pAccess=nullptr)
	Constructor.
virtual	~Directory ()
	Destructor.
bool	Create ()
	Create directory.
PLCORE_API bool	CreateRecursive ()
	Create a directory recursively.
bool	Delete ()
	Delete directory.
PLCORE_API FileSearch *	Search (const String &sFilter) const
	Returns a file searcher for listing the content of a directory.

---

Detailed Description

Class for accessing a directory within the file system.

---

Constructor & Destructor Documentation

PLCore::Directory::Directory

(

)

[inline]

Constructor.

PLCore::Directory::Directory	(	const String &	sUrl,
		const FileAccess *	pAccess = nullptr
	)		[inline]

Constructor.

Parameters:

[in]	sUrl	URL of a directory
[in]	pAccess	Additional file access information (can be a null pointer)

PLCore::Directory::Directory	(	const Url &	cUrl,
		const FileAccess *	pAccess = nullptr
	)		[inline]

Constructor.

Parameters:

[in]	cUrl	URL of a directory
[in]	pAccess	Additional file access information (can be a null pointer)

PLCore::Directory::~Directory

(

)

[inline, virtual]

Destructor.

Note:

• The directory is closed automatically

---

Member Function Documentation

bool PLCore::Directory::Create

(

)

[inline]

Create directory.

Returns:

'true', if all went fine, else 'false'

PLCORE_API bool PLCore::Directory::CreateRecursive

(

)

Create a directory recursively.

Returns:

'true', if all went fine, else 'false'

bool PLCore::Directory::Delete

(

)

[inline]

Delete directory.

Returns:

'true', if all went fine, else 'false'

PLCORE_API FileSearch* PLCore::Directory::Search

(

const String &

sFilter

)

const

Returns a file searcher for listing the content of a directory.

Parameters:

[in]

sFilter

Filter to be applied (e.g. "*.txt")

Returns:

Pointer to a new file searcher, a null pointer on error (has to be deleted be the caller)

---

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

• Directory.h
• Directory.inl