CfbReader
Overview
CfbReader is a class in Aspose.Email FOSS for .NET.
Inherits from: IDisposable.
CfbReader.CfbReader creates a reader from a byte array containing a CFB container.
Description
CfbReader is a class in the Aspose.Email FOSS library for .NET that exposes 11 methods and 13 properties for programmatic use. It extends IDisposable, inheriting shared functionality from its parent type.
The class also provides the Header property (provides the cfb file header information), the Difat property (contains the difat sector indices as a read‑only collection), the DirectoryEntries property (lists all directory entries in the container).
Instances are created through a single constructor that initializes the object with default values.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
Header | Header | Read | Provides the CFB file header information |
Difat | ReadOnlyCollection<uint> | Read | Contains the DIFAT sector indices as a read‑only collection |
Fat | ReadOnlyCollection<uint> | Read | |
MiniFat | ReadOnlyCollection<uint> | Read | |
DirectoryEntries | ReadOnlyCollection<DirectoryEntry> | Read | Lists all directory entries in the container |
RootEntry | DirectoryEntry | Read | Represents the root storage directory entry |
MiniStream | byte[] | Read | Holds the raw bytes of the mini‑stream |
MajorVersion | int | Read | Indicates the major version number of the CFB format |
SectorSize | int | Read | Returns the size in bytes of a standard sector |
MiniSectorSize | int | Read | Returns the size in bytes of a mini sector |
DirectoryEntryCount | int | Read | Reports the total number of directory entries |
MaterializedStreamCount | int | Read | Reports how many streams have been materialized |
FileSize | int | Read | Gives the total size in bytes of the CFB file |
Methods
| Signature | Description |
|---|---|
CfbReader(data: byte[]) | Creates a reader from a byte array containing a CFB container |
FromFile(path: string) | Loads a CFB container from the specified file path |
FromStream(stream: Stream) | Loads a CFB container from the provided Stream |
Dispose() | Releases all resources used by the reader |
GetEntry(streamId: uint) | Returns the directory entry for the given stream identifier |
GetStreamData(streamId: uint) | Reads the raw byte data of the specified stream |
IterStorages() | Enumerates all storage entries in the CFB |
IterStreams() | Enumerates all stream entries in the CFB |
IterChildren(storageStreamId: uint) | Enumerates child entries of the given storage stream |
IterTree(startStreamId: uint) | Walks the directory tree starting at the given stream ID |
FindChildByName(storageStreamId: uint, name: string) | Finds a child entry by name within a storage |
ResolvePath(names: IEnumerable<string>, startStreamId: uint) | Resolves a sequence of names to a stream ID starting from a base |