Utility class implementing a IFileInterface base class.
More...
#include <murl_util_file_interface.h>
Utility class implementing a IFileInterface base class.
|
| FileInterface () |
| The constructor.
|
|
virtual | ~FileInterface () |
| The destructor.
|
|
virtual Bool | GetAbsoluteName (const String &relativeName, IEnums::FileCategory category, String &absoluteName) |
| Implementation of IFileInterface::GetAbsoluteName(). More...
|
|
virtual Bool | GetAllFileNames (const String &relativePath, IEnums::FileCategory category, StringArray &names) |
| Implementation of IFileInterface::GetAllFileNames(). More...
|
|
virtual Bool | GetAllFolderNames (const String &relativePath, IEnums::FileCategory category, StringArray &names) |
| Implementation of IFileInterface::GetAllFolderNames(). More...
|
|
virtual IFile * | OpenFile (const String &name, IEnums::FileCategory category, IEnums::FileAccessMode mode, Bool createFolders) |
| Implementation of IFileInterface::OpenFile(). More...
|
|
virtual Bool | CloseFile (IFile *&handle) |
| Implementation of IFileInterface::CloseFile(). More...
|
|
virtual Bool | MapFileData (const String &name, IEnums::FileCategory category, ConstData &data) |
| Implementation of IFileInterface::MapFileData(). More...
|
|
virtual Bool | UnmapFileData (ConstData &data) |
| Implementation of IFileInterface::UnmapFileData(). More...
|
|
virtual Bool | FileExists (const String &name, IEnums::FileCategory category)=0 |
| Check if a file exists. More...
|
|
virtual Bool | FolderExists (const String &name, IEnums::FileCategory category)=0 |
| Check if a folder exists. More...
|
|
◆ GetAbsoluteName()
Implementation of IFileInterface::GetAbsoluteName().
- Parameters
-
relativeName | The name of the file. |
category | The category where the file reside. |
absoluteName | The absolute file name return value. |
- Returns
- true if successful, if false the 'absoluteName' return value is unchanged.
Implements Murl::IFileInterface.
◆ GetAllFileNames()
Implementation of IFileInterface::GetAllFileNames().
- Parameters
-
relativePath | The name of the folder. |
category | The category where the folder reside. |
names | The array of file names return value. |
- Returns
- true if successful, if false the 'names' return value is unchanged.
Implements Murl::IFileInterface.
◆ GetAllFolderNames()
Implementation of IFileInterface::GetAllFolderNames().
- Parameters
-
relativePath | The name of the folder. |
category | The category where the folder reside. |
names | The array of folder names return value. |
- Returns
- true if successful, if false the 'names' return value is unchanged.
Implements Murl::IFileInterface.
◆ OpenFile()
Implementation of IFileInterface::OpenFile().
- Parameters
-
name | The name of the file. |
category | The category where the file reside. |
mode | The access mode for the file to open. |
createFolders | Create the folders constained in file name if the folders do not exist. |
- Returns
- The file interface or null if not successful.
Implements Murl::IFileInterface.
◆ CloseFile()
virtual Bool Murl::Util::FileInterface::CloseFile |
( |
IFile *& |
handle | ) |
|
|
virtual |
◆ MapFileData()
Implementation of IFileInterface::MapFileData().
- Parameters
-
name | The name of the file. |
category | The category where the file reside. |
data | The file data object return value. |
- Returns
- true if successful, if false the 'data' return value is unchanged.
Implements Murl::IFileInterface.
◆ UnmapFileData()
virtual Bool Murl::Util::FileInterface::UnmapFileData |
( |
ConstData & |
data | ) |
|
|
virtual |
◆ MapFile()
Memory-map a read-only file.
- Parameters
-
name | The name of the file. |
category | The category where the file reside. |
data | The file data pointer return value. |
byteSize | The byte size return value. |
- Returns
- true if successful, if false the return values stay unchanged.
Implemented in Murl::Util::ToolsFileInterface.
◆ UnmapFile()
virtual Bool Murl::Util::FileInterface::UnmapFile |
( |
const UInt8 * |
data | ) |
|
|
protectedpure virtual |
◆ CreateFolder()
virtual Bool Murl::Util::FileInterface::CreateFolder |
( |
const String & |
absolutePath | ) |
|
|
protectedpure virtual |
◆ GetAbsolutePath()
Get the absolute folder path to a file category.
- Parameters
-
category | The category of the folder. |
absolutePath | The path of the folder return value. |
- Returns
- true if successful.
Implemented in Murl::Util::ToolsFileInterface.
The documentation for this class was generated from the following file:
- murl_util_file_interface.h