Nirtcpp 2.0.0
Nirtcpp is a high-performance c++ graphics engine.
nirt::io::IFileSystem Class Referenceabstract

The FileSystem manages files and archives and provides access to them. More...

#include <nirtcpp/IFileSystem.hpp>

Inheritance diagram for nirt::io::IFileSystem:
Inheritance graph
Collaboration diagram for nirt::io::IFileSystem:
Collaboration graph

Public Member Functions

virtual IReadFilecreateAndOpenFile (const path &filename)=0
 Opens a file for read access. More...
 
virtual IReadFilecreateMemoryReadFile (const void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped=false)=0
 Creates an IReadFile interface for accessing memory like a file. More...
 
virtual IReadFilecreateLimitReadFile (const path &fileName, IReadFile *alreadyOpenedFile, long pos, long areaSize)=0
 Creates an IReadFile interface for accessing files inside files. More...
 
virtual IWriteFilecreateMemoryWriteFile (void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped=false)=0
 Creates an IWriteFile interface for accessing memory like a file. More...
 
virtual IWriteFilecreateAndWriteFile (const path &filename, bool append=false)=0
 Opens a file for write access. More...
 
virtual bool addFileArchive (const path &filename, bool ignoreCase=true, bool ignorePaths=true, E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN, const core::stringc &password="", IFileArchive **retArchive=0)=0
 Adds an archive to the file system. More...
 
virtual bool addFileArchive (IReadFile *file, bool ignoreCase=true, bool ignorePaths=true, E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN, const core::stringc &password="", IFileArchive **retArchive=0)=0
 Adds an archive to the file system. More...
 
virtual bool addFileArchive (IFileArchive *archive)=0
 Adds an archive to the file system. More...
 
virtual u32 getFileArchiveCount () const =0
 Get the number of archives currently attached to the file system.
 
virtual bool removeFileArchive (u32 index)=0
 Removes an archive from the file system. More...
 
virtual bool removeFileArchive (const path &filename)=0
 Removes an archive from the file system. More...
 
virtual bool removeFileArchive (const IFileArchive *archive)=0
 Removes an archive from the file system. More...
 
virtual bool moveFileArchive (u32 sourceIndex, s32 relative)=0
 Changes the search order of attached archives. More...
 
virtual IFileArchivegetFileArchive (u32 index)=0
 Get the archive at a given index.
 
virtual void addArchiveLoader (IArchiveLoader *loader)=0
 Adds an external archive loader to the engine. More...
 
virtual u32 getArchiveLoaderCount () const =0
 Gets the number of archive loaders currently added.
 
virtual IArchiveLoadergetArchiveLoader (u32 index) const =0
 Retrieve the given archive loader. More...
 
virtual NIRT_DEPRECATED bool addZipFileArchive (const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)
 Adds a zip archive to the file system. More...
 
virtual NIRT_DEPRECATED bool addFolderFileArchive (const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)
 Adds an unzipped archive (or basedirectory with subdirectories..) to the file system. More...
 
virtual NIRT_DEPRECATED bool addPakFileArchive (const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)
 Adds a pak archive to the file system. More...
 
virtual const pathgetWorkingDirectory ()=0
 Get the current working directory. More...
 
virtual bool changeWorkingDirectoryTo (const path &newDirectory)=0
 Changes the current working directory. More...
 
virtual path getAbsolutePath (const path &filename) const =0
 Converts a relative path to an absolute (unique) path, resolving symbolic links if required. More...
 
virtual path getFileDir (const path &filename) const =0
 Get the directory a file is located in. More...
 
virtual path getFileBasename (const path &filename, bool keepExtension=true) const =0
 Get the base part of a filename, i.e. the name without the directory part. More...
 
virtual pathflattenFilename (path &directory, const path &root="/") const =0
 flatten a path and file name for example: "/you/me/../." becomes "/you"
 
virtual path getRelativeFilename (const path &filename, const path &directory) const =0
 Get the relative filename, relative to the given directory.
 
virtual IFileListcreateFileList ()=0
 Creates a list of files and directories in the current working directory and returns it. More...
 
virtual IFileListcreateEmptyFileList (const io::path &path, bool ignoreCase, bool ignorePaths)=0
 Creates an empty filelist. More...
 
virtual EFileSystemType setFileListSystem (EFileSystemType listType)=0
 Set the active type of file system.
 
virtual bool existFile (const path &filename) const =0
 Determines if a file exists and could be opened. More...
 
virtual IXMLReadercreateXMLReader (const path &filename)=0
 Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*). More...
 
virtual IXMLReadercreateXMLReader (IReadFile *file)=0
 Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*). More...
 
virtual IXMLReaderUTF8createXMLReaderUTF8 (const path &filename)=0
 Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*). More...
 
virtual IXMLReaderUTF8createXMLReaderUTF8 (IReadFile *file)=0
 Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*). More...
 
virtual IXMLWriterUTF8createXMLWriterUTF8 (const path &filename)=0
 Creates a XML Writer from a file which will write ASCII/UTF-8 characters (char*). More...
 
virtual IXMLWriterUTF8createXMLWriterUTF8 (IWriteFile *file)=0
 Creates a XML Writer from a file which will write ASCII/UTF-8 characters (char*). More...
 
virtual IXMLWritercreateXMLWriter (const path &filename)=0
 Creates a XML Writer from a file. More...
 
virtual IXMLWritercreateXMLWriter (IWriteFile *file)=0
 Creates a XML Writer from a file. More...
 
virtual IAttributescreateEmptyAttributes (video::IVideoDriver *driver=0)=0
 Creates a new empty collection of attributes, usable for serialization and more. More...
 
- Public Member Functions inherited from nirt::IReferenceCounted
 IReferenceCounted ()
 Constructor.
 
virtual ~IReferenceCounted ()
 Destructor.
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from nirt::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

The FileSystem manages files and archives and provides access to them.

It manages where files are, so that modules which use the the IO do not need to know where every file is located. A file could be in a .zip-Archive or as file on disk, using the IFileSystem makes no difference to this.

Member Function Documentation

◆ addArchiveLoader()

virtual void nirt::io::IFileSystem::addArchiveLoader ( IArchiveLoader loader)
pure virtual

Adds an external archive loader to the engine.

Use this function to add support for new archive types to the engine, for example proprietary or encrypted file storage.

◆ addFileArchive() [1/3]

virtual bool nirt::io::IFileSystem::addFileArchive ( const path filename,
bool  ignoreCase = true,
bool  ignorePaths = true,
E_FILE_ARCHIVE_TYPE  archiveType = EFAT_UNKNOWN,
const core::stringc password = "",
IFileArchive **  retArchive = 0 
)
pure virtual

Adds an archive to the file system.

After calling this, the Nirtcpp Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files. By default Nirtcpp supports ZIP, PAK, TAR, PNK, and directories as archives. You can provide your own archive types by implementing IArchiveLoader and passing an instance to addArchiveLoader. Nirtcpp supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2.

Parameters
filenameFilename of the archive to add to the file system.
ignoreCaseIf set to true, files in the archive can be accessed without writing all letters in the right case.
ignorePathsIf set to true, files in the added archive can be accessed without its complete path.
archiveTypeIf no specific E_FILE_ARCHIVE_TYPE is selected then the type of archive will depend on the extension of the file name. If you use a different extension then you can use this parameter to force a specific type of archive.
passwordAn optional password, which is used in case of encrypted archives.
retArchiveA pointer that will be set to the archive that is added.
Returns
True if the archive was added successfully, false if not.

◆ addFileArchive() [2/3]

virtual bool nirt::io::IFileSystem::addFileArchive ( IFileArchive archive)
pure virtual

Adds an archive to the file system.

Parameters
archiveThe archive to add to the file system.
Returns
True if the archive was added successfully, false if not.

◆ addFileArchive() [3/3]

virtual bool nirt::io::IFileSystem::addFileArchive ( IReadFile file,
bool  ignoreCase = true,
bool  ignorePaths = true,
E_FILE_ARCHIVE_TYPE  archiveType = EFAT_UNKNOWN,
const core::stringc password = "",
IFileArchive **  retArchive = 0 
)
pure virtual

Adds an archive to the file system.

After calling this, the Nirtcpp Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files. By default Nirtcpp supports ZIP, PAK, TAR, PNK, and directories as archives. You can provide your own archive types by implementing IArchiveLoader and passing an instance to addArchiveLoader. Nirtcpp supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2. If you want to add a directory as an archive, prefix its name with a slash in order to let Nirtcpp recognize it as a folder mount (mypath/). Using this technique one can build up a search order, because archives are read first, and can be used more easily with relative filenames.

Parameters
fileArchive to add to the file system.
ignoreCaseIf set to true, files in the archive can be accessed without writing all letters in the right case.
ignorePathsIf set to true, files in the added archive can be accessed without its complete path.
archiveTypeIf no specific E_FILE_ARCHIVE_TYPE is selected then the type of archive will depend on the extension of the file name. If you use a different extension then you can use this parameter to force a specific type of archive.
passwordAn optional password, which is used in case of encrypted archives.
retArchiveA pointer that will be set to the archive that is added.
Returns
True if the archive was added successfully, false if not.

◆ addFolderFileArchive()

virtual NIRT_DEPRECATED bool nirt::io::IFileSystem::addFolderFileArchive ( const c8 filename,
bool  ignoreCase = true,
bool  ignorePaths = true 
)
inlinevirtual

Adds an unzipped archive (or basedirectory with subdirectories..) to the file system.

Deprecated:
This function is provided for compatibility with older versions of Nirtcpp and may be removed in Nirtcpp 1.9, you should use addFileArchive instead. Useful for handling data which will be in a zip file
Parameters
filenameFilename of the unzipped zip archive base directory to add to the file system.
ignoreCaseIf set to true, files in the archive can be accessed without writing all letters in the right case.
ignorePathsIf set to true, files in the added archive can be accessed without its complete path.
Returns
True if the archive was added successful, false if not.

◆ addPakFileArchive()

virtual NIRT_DEPRECATED bool nirt::io::IFileSystem::addPakFileArchive ( const c8 filename,
bool  ignoreCase = true,
bool  ignorePaths = true 
)
inlinevirtual

Adds a pak archive to the file system.

Deprecated:
This function is provided for compatibility with older versions of Nirtcpp and may be removed in Nirtcpp 1.9, you should use addFileArchive instead. After calling this, the Nirtcpp Engine will search and open files directly from this archive too. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake2/KingPin/Hexen2 .pak files
Parameters
filenameFilename of the pak archive to add to the file system.
ignoreCaseIf set to true, files in the archive can be accessed without writing all letters in the right case.
ignorePathsIf set to true, files in the added archive can be accessed without its complete path.(should not use with Quake2 paks
Returns
True if the archive was added successful, false if not.

◆ addZipFileArchive()

virtual NIRT_DEPRECATED bool nirt::io::IFileSystem::addZipFileArchive ( const c8 filename,
bool  ignoreCase = true,
bool  ignorePaths = true 
)
inlinevirtual

Adds a zip archive to the file system.

Deprecated:
This function is provided for compatibility with older versions of Nirtcpp and may be removed in Nirtcpp 1.9, you should use addFileArchive instead. After calling this, the Nirtcpp Engine will search and open files directly from this archive too. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are no different than .zip files.
Parameters
filenameFilename of the zip archive to add to the file system.
ignoreCaseIf set to true, files in the archive can be accessed without writing all letters in the right case.
ignorePathsIf set to true, files in the added archive can be accessed without its complete path.
Returns
True if the archive was added successfully, false if not.

◆ changeWorkingDirectoryTo()

virtual bool nirt::io::IFileSystem::changeWorkingDirectoryTo ( const path newDirectory)
pure virtual

Changes the current working directory.

Parameters
newDirectoryA string specifying the new working directory. The string is operating system dependent. Under Windows it has the form "<drive>:\<directory>\<sudirectory>\<..>". An example would be: "C:\Windows\"
Returns
True if successful, otherwise false.

◆ createAndOpenFile()

virtual IReadFile * nirt::io::IFileSystem::createAndOpenFile ( const path filename)
pure virtual

Opens a file for read access.

Parameters
filenameName of file to open.
Returns
Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

◆ createAndWriteFile()

virtual IWriteFile * nirt::io::IFileSystem::createAndWriteFile ( const path filename,
bool  append = false 
)
pure virtual

Opens a file for write access.

Parameters
filenameName of file to open.
appendIf the file already exist, all write operations are appended to the file.
Returns
Pointer to the created file interface. 0 is returned, if the file could not created or opened for writing. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

◆ createEmptyAttributes()

virtual IAttributes * nirt::io::IFileSystem::createEmptyAttributes ( video::IVideoDriver driver = 0)
pure virtual

Creates a new empty collection of attributes, usable for serialization and more.

Parameters
driverVideo driver to be used to load textures when specified as attribute values. Can be null to prevent automatic texture loading by attributes.
Returns
Pointer to the created object. If you no longer need the object, you should call IAttributes::drop(). See IReferenceCounted::drop() for more information.

◆ createEmptyFileList()

virtual IFileList * nirt::io::IFileSystem::createEmptyFileList ( const io::path path,
bool  ignoreCase,
bool  ignorePaths 
)
pure virtual

Creates an empty filelist.

Returns
a Pointer to the created IFileList is returned. After the list has been used it has to be deleted using its IFileList::drop() method. See IReferenceCounted::drop() for more information.

◆ createFileList()

virtual IFileList * nirt::io::IFileSystem::createFileList ( )
pure virtual

Creates a list of files and directories in the current working directory and returns it.

Returns
a Pointer to the created IFileList is returned. After the list has been used it has to be deleted using its IFileList::drop() method. See IReferenceCounted::drop() for more information.

◆ createLimitReadFile()

virtual IReadFile * nirt::io::IFileSystem::createLimitReadFile ( const path fileName,
IReadFile alreadyOpenedFile,
long  pos,
long  areaSize 
)
pure virtual

Creates an IReadFile interface for accessing files inside files.

This is useful e.g. for archives.

Parameters
fileNameThe name given to this file
alreadyOpenedFilePointer to the enclosing file
posStart of the file inside alreadyOpenedFile
areaSizeThe length of the file
Returns
A pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

◆ createMemoryReadFile()

virtual IReadFile * nirt::io::IFileSystem::createMemoryReadFile ( const void *  memory,
s32  len,
const path fileName,
bool  deleteMemoryWhenDropped = false 
)
pure virtual

Creates an IReadFile interface for accessing memory like a file.

This allows you to use a pointer to memory where an IReadFile is requested.

Parameters
memoryA pointer to the start of the file in memory
lenThe length of the memory in bytes
fileNameThe name given to this file
deleteMemoryWhenDroppedTrue if the memory should be deleted along with the IReadFile when it is dropped.
Returns
Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

◆ createMemoryWriteFile()

virtual IWriteFile * nirt::io::IFileSystem::createMemoryWriteFile ( void *  memory,
s32  len,
const path fileName,
bool  deleteMemoryWhenDropped = false 
)
pure virtual

Creates an IWriteFile interface for accessing memory like a file.

This allows you to use a pointer to memory where an IWriteFile is requested. You are responsible for allocating enough memory.

Parameters
memoryA pointer to the start of the file in memory (allocated by you)
lenThe length of the memory in bytes
fileNameThe name given to this file
deleteMemoryWhenDroppedTrue if the memory should be deleted along with the IWriteFile when it is dropped.
Returns
Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

◆ createXMLReader() [1/2]

virtual IXMLReader * nirt::io::IFileSystem::createXMLReader ( const path filename)
pure virtual

Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*).

Use createXMLReaderUTF8() if you prefer char* instead of wchar_t*. See IIrrXMLReader for more information on how to use the parser.

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReader::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLReader() [2/2]

virtual IXMLReader * nirt::io::IFileSystem::createXMLReader ( IReadFile file)
pure virtual

Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*).

Use createXMLReaderUTF8() if you prefer char* instead of wchar_t*. See IIrrXMLReader for more information on how to use the parser.

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReader::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLReaderUTF8() [1/2]

virtual IXMLReaderUTF8 * nirt::io::IFileSystem::createXMLReaderUTF8 ( const path filename)
pure virtual

Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*).

Use createXMLReader() if you prefer wchar_t* instead of char*. See IIrrXMLReader for more information on how to use the parser.

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReaderUTF8::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLReaderUTF8() [2/2]

virtual IXMLReaderUTF8 * nirt::io::IFileSystem::createXMLReaderUTF8 ( IReadFile file)
pure virtual

Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*).

Use createXMLReader() if you prefer wchar_t* instead of char*. See IIrrXMLReader for more information on how to use the parser.

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReaderUTF8::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLWriter() [1/2]

virtual IXMLWriter * nirt::io::IFileSystem::createXMLWriter ( const path filename)
pure virtual

Creates a XML Writer from a file.

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLWriter is returned. After use, the reader has to be deleted using its IXMLWriter::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLWriter() [2/2]

virtual IXMLWriter * nirt::io::IFileSystem::createXMLWriter ( IWriteFile file)
pure virtual

Creates a XML Writer from a file.

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLWriter is returned. After use, the reader has to be deleted using its IXMLWriter::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLWriterUTF8() [1/2]

virtual IXMLWriterUTF8 * nirt::io::IFileSystem::createXMLWriterUTF8 ( const path filename)
pure virtual

Creates a XML Writer from a file which will write ASCII/UTF-8 characters (char*).

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLWriter is returned. After use, the reader has to be deleted using its IXMLWriter::drop() method. See IReferenceCounted::drop() for more information.

◆ createXMLWriterUTF8() [2/2]

virtual IXMLWriterUTF8 * nirt::io::IFileSystem::createXMLWriterUTF8 ( IWriteFile file)
pure virtual

Creates a XML Writer from a file which will write ASCII/UTF-8 characters (char*).

Returns
0, if file could not be opened, otherwise a pointer to the created IXMLWriter is returned. After use, the reader has to be deleted using its IXMLWriter::drop() method. See IReferenceCounted::drop() for more information.

◆ existFile()

virtual bool nirt::io::IFileSystem::existFile ( const path filename) const
pure virtual

Determines if a file exists and could be opened.

Parameters
filenameis the string identifying the file which should be tested for existence.
Returns
True if file exists, and false if it does not exist or an error occurred.

◆ getAbsolutePath()

virtual path nirt::io::IFileSystem::getAbsolutePath ( const path filename) const
pure virtual

Converts a relative path to an absolute (unique) path, resolving symbolic links if required.

Parameters
filenamePossibly relative file or directory name to query.
Returns
Absolute filename which points to the same file.

◆ getArchiveLoader()

virtual IArchiveLoader * nirt::io::IFileSystem::getArchiveLoader ( u32  index) const
pure virtual

Retrieve the given archive loader.

Parameters
indexThe index of the loader to retrieve. This parameter is an 0-based array index.
Returns
A pointer to the specified loader, 0 if the index is incorrect.

◆ getFileBasename()

virtual path nirt::io::IFileSystem::getFileBasename ( const path filename,
bool  keepExtension = true 
) const
pure virtual

Get the base part of a filename, i.e. the name without the directory part.

If no directory is prefixed, the full name is returned.

Parameters
filenameThe file to get the basename from
keepExtensionTrue if filename with extension is returned otherwise everything after the final '.' is removed as well.

◆ getFileDir()

virtual path nirt::io::IFileSystem::getFileDir ( const path filename) const
pure virtual

Get the directory a file is located in.

Parameters
filenameThe file to get the directory from.
Returns
String containing the directory of the file.

◆ getWorkingDirectory()

virtual const path & nirt::io::IFileSystem::getWorkingDirectory ( )
pure virtual

Get the current working directory.

Returns
Current working directory as a string.

◆ moveFileArchive()

virtual bool nirt::io::IFileSystem::moveFileArchive ( u32  sourceIndex,
s32  relative 
)
pure virtual

Changes the search order of attached archives.

Parameters
sourceIndexThe index of the archive to change
relativeThe relative change in position, archives with a lower index are searched first

◆ removeFileArchive() [1/3]

virtual bool nirt::io::IFileSystem::removeFileArchive ( const IFileArchive archive)
pure virtual

Removes an archive from the file system.

This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes.

Parameters
archiveThe archive to remove.
Returns
True on success, false on failure

◆ removeFileArchive() [2/3]

virtual bool nirt::io::IFileSystem::removeFileArchive ( const path filename)
pure virtual

Removes an archive from the file system.

This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes. Note that a relative filename might be interpreted differently on each call, depending on the current working directory. In case you want to remove an archive that was added using a relative path name, you have to change to the same working directory again. This means, that the filename given on creation is not an identifier for the archive, but just a usual filename that is used for locating the archive to work with.

Parameters
filenameThe archive pointed to by the name will be removed
Returns
True on success, false on failure

◆ removeFileArchive() [3/3]

virtual bool nirt::io::IFileSystem::removeFileArchive ( u32  index)
pure virtual

Removes an archive from the file system.

This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes.

Parameters
indexThe index of the archive to remove
Returns
True on success, false on failure

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