Class TFileArchive

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TFileArchive = class(TReferenceCounted)

Description

A TFileArchive manages archives and provides access to files inside of them.

Hierarchy

Overview

Methods

Public function CreateAndOpenFile(const FileName: StringType): TReadFile; overload; inline;
Public function CreateAndOpenFile(Index: LongWord): TReadFile; overload; inline;
Public function GetFileList: TFileList; inline;

Properties

Public property ArchiveType: TFileArchiveType read GetType;
Public property Password: AnsiString read GetPassword write SetPassword;

Description

Methods

Public function CreateAndOpenFile(const FileName: StringType): TReadFile; overload; inline;

Opens a file based on its name.

Parameters
FileName
The file to open.
Returns

A pointer to the created file on success; nil on failure.

Public function CreateAndOpenFile(Index: LongWord): TReadFile; overload; inline;

Opens a file based on its position in the file list.

Parameters
Index
The file index in the directory list.
Returns

The opened file on success; nil on failure.

Public function GetFileList: TFileList; inline;

Returns a file list containing the complete directory tree for the archive.

Properties

Public property ArchiveType: TFileArchiveType read GetType;

The Archive Type.

Public property Password: AnsiString read GetPassword write SetPassword;

An optionally used password string.


Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22