PLCore::FileAccess Class Reference

This class contains information about how to access a file. More...

#include <FileAccess.h>

List of all members.

Classes
class	Entry
	Contains access information for a certain file/URL. More...
Public Member Functions
PLCORE_API	FileAccess ()
	Constructor.
PLCORE_API	FileAccess (const FileAccess &cFileAccess)
	Copy constructor.
PLCORE_API	~FileAccess ()
	Destructor.
PLCORE_API FileAccess &	operator= (const FileAccess &cFileAccess)
	Assignment operator.
PLCORE_API bool	HasEntry (const String &sName) const
	Check if an entry with a given name is available.
PLCORE_API const Entry &	GetEntry (const String &sName) const
	Returns an entry with a given name.
PLCORE_API const Entry &	operator[] (const String &sName) const
PLCORE_API Entry &	GetEntry (const String &sName)
	Returns an entry with a given name.
PLCORE_API Entry &	operator[] (const String &sName)
Static Public Attributes
static const Entry	NullEntry

---

Detailed Description

This class contains information about how to access a file.

Remarks:

It can be used to supply authentication for files, e.g. username and password for a HTTP-connection or a password for an encrypted ZIP-file, as well as other access options. Please consider this information as hints that can be passed to the file-functions, it is not guaranteed that everything you enter here will be used! (e.g. a ZIP-file won't be open with Write-Access, regardless of what you pass in FlagsMask/FlagsValue)

---

Constructor & Destructor Documentation

PLCORE_API PLCore::FileAccess::FileAccess

(

)

Constructor.

PLCORE_API PLCore::FileAccess::FileAccess

(

const FileAccess &

cFileAccess

)

Copy constructor.

Parameters:

[in]

cFileAccess

FileAccess object to copy

PLCORE_API PLCore::FileAccess::~FileAccess

(

)

Destructor.

---

Member Function Documentation

PLCORE_API FileAccess& PLCore::FileAccess::operator=

(

const FileAccess &

cFileAccess

)

Assignment operator.

Parameters:

[in]

cFileAccess

'FileAccess' object to copy

Returns:

Reference to this instance

PLCORE_API bool PLCore::FileAccess::HasEntry

(

const String &

sName

)

const

Check if an entry with a given name is available.

Parameters:

[in]

sName

Name of the entry

Returns:

'true' if the entry is set, else 'false'

PLCORE_API const Entry& PLCore::FileAccess::GetEntry

(

const String &

sName

)

const

Returns an entry with a given name.

Parameters:

[in]

sName

Name of the entry

Returns:

Reference to that entry if it exists, else 'NullEntry'

PLCORE_API const Entry& PLCore::FileAccess::operator[]

(

const String &

sName

)

const

PLCORE_API Entry& PLCore::FileAccess::GetEntry

(

const String &

sName

)

Returns an entry with a given name.

Parameters:

[in]

sName

Name of the entry

Returns:

Reference to that entry, creates a new entry if it didn't exist before

PLCORE_API Entry& PLCore::FileAccess::operator[]

(

const String &

sName

)

---

Member Data Documentation

const Entry PLCore::FileAccess::NullEntry [static]

Empty entry

---

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

• FileAccess.h