C# Class Files.DBPF.DBPFArchive

Inheritance: IDisposable
Show file Open project: Afr0Games/Project-Dollhouse Class Usage Examples

Public Properties

Property Type Description
IndexEntryCount uint
IndexOffset uint
IndexSize uint

Public Methods

Method Description
ContainsEntry ( UniqueFileID ID ) : bool

Does this archive contain the specified entry?
DBPFArchive ( string Path ) : System
Dispose ( ) : void
GrabEntriesForGroupID ( uint GroupID ) : List
GrabEntriesForTypeID ( uint TypeID, uint GroupID ) : List

Graps all the entries with the specified TypeID in a particular group, specified by GroupID.
GrabEntry ( UniqueFileID ID ) : Stream

Returns an entry in this archive as a Stream instance. Throws a DBPFException if entry was not found.
ReadArchive ( bool ThrowException ) : bool

Reads all entries in this archive into memory.

Protected Methods

Method Description
Dispose ( bool CleanUpNativeAndManagedResources ) : void

Method Details

ContainsEntry() public method

Does this archive contain the specified entry?
public ContainsEntry ( UniqueFileID ID ) : bool
ID UniqueFileID ID of the entry to search for.
return bool

DBPFArchive() public method

public DBPFArchive ( string Path ) : System
Path string
return System

Dispose() public method

public Dispose ( ) : void
return void

Dispose() protected method

protected Dispose ( bool CleanUpNativeAndManagedResources ) : void
CleanUpNativeAndManagedResources bool
return void

GrabEntriesForGroupID() public method

public GrabEntriesForGroupID ( uint GroupID ) : List
GroupID uint
return List

GrabEntriesForTypeID() public method

Graps all the entries with the specified TypeID in a particular group, specified by GroupID.
public GrabEntriesForTypeID ( uint TypeID, uint GroupID ) : List
TypeID uint Return entries with this TypeID.
GroupID uint The group to look in.
return List

GrabEntry() public method

Returns an entry in this archive as a Stream instance. Throws a DBPFException if entry was not found.
public GrabEntry ( UniqueFileID ID ) : Stream
ID UniqueFileID ID of the entry to grab from archive.
return Stream

ReadArchive() public method

Reads all entries in this archive into memory.
public ReadArchive ( bool ThrowException ) : bool
ThrowException bool Wether or not to throw an exception if the archive was not a DBPF. If false, function will return.
return bool

Property Details

IndexEntryCount public property

public uint IndexEntryCount
return uint

IndexOffset public property

public uint IndexOffset
return uint

IndexSize public property

public uint IndexSize
return uint