API Reference
ArchiveReader
Reads selected archive content without filesystem publication or executing its contents.
Inheritance
- Object
- ArchiveReader
Methods
public static IReadOnlyList<ArchiveEntryDescriptor> EnumerateZip(String zipPath, ArchiveTraversalOptions? options = null) #IReadOnlyList<ArchiveEntryDescriptor>Enumerates ZIP entries from a path.
Parameters
- zipPath System.String
- options OfficeIMO.Archives.ArchiveTraversalOptions? = null
public static IReadOnlyList<ArchiveEntryDescriptor> EnumerateZip(Stream zipStream, ArchiveTraversalOptions? options = null) #IReadOnlyList<ArchiveEntryDescriptor>Enumerates ZIP entries from a stream.
Parameters
- zipStream System.IO.Stream
- options OfficeIMO.Archives.ArchiveTraversalOptions? = null
public static IReadOnlyList<ArchiveEntryData> ReadZip(Byte[] bytes, ArchiveReadOptions? options = null, CancellationToken cancellationToken = default) #IReadOnlyList<ArchiveEntryData>Reads a ZIP from bytes using the same strict member validation as extraction. Returns only after every selected payload is fully verified. Do not modify the input during this call.
Parameters
- bytes System.Byte[]
- options OfficeIMO.Archives.ArchiveReadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Exceptions
OfficeInspectionResourceLimitException– A configured or managed admission ceiling is exhausted.
public static IReadOnlyList<ArchiveEntryData> ReadZip(Stream source, ArchiveReadOptions? options = null, CancellationToken cancellationToken = default) #IReadOnlyList<ArchiveEntryData>Reads from the stream's current position to EOF into a bounded snapshot. Supports nonseekable streams, leaves the caller's stream open, and advances its position by the bytes read. Selected content is independent of the stream after return.
Parameters
- source System.IO.Stream
- options OfficeIMO.Archives.ArchiveReadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Exceptions
OfficeInspectionResourceLimitException– A configured or managed admission ceiling is exhausted.
public static ArchiveTraversalResult TraverseZip(String zipPath, ArchiveTraversalOptions? options = null) #ArchiveTraversalResultTraverses ZIP entries from a path and returns accepted entries with warnings.
Parameters
- zipPath System.String
- options OfficeIMO.Archives.ArchiveTraversalOptions? = null
public static ArchiveTraversalResult TraverseZip(Stream zipStream, ArchiveTraversalOptions? options = null) #ArchiveTraversalResultTraverses ZIP entries from a stream and returns accepted entries with warnings.
Parameters
- zipStream System.IO.Stream
- options OfficeIMO.Archives.ArchiveTraversalOptions? = null
public static ArchiveTraversalResult TraverseZip(Stream zipStream, ArchiveTraversalOptions? options, CancellationToken cancellationToken) #ArchiveTraversalResultTraverses a ZIP source with a physical-entry preflight and cooperative cancellation.
Parameters
- zipStream System.IO.Stream
- options OfficeIMO.Archives.ArchiveTraversalOptions?
- cancellationToken System.Threading.CancellationToken
public static ArchiveTraversalResult TraverseZip(ZipArchive archive, ArchiveTraversalOptions? options = null) #ArchiveTraversalResultTraverses ZIP entries from an already opened archive and returns accepted entries with warnings.
Parameters
- archive System.IO.Compression.ZipArchive
- options OfficeIMO.Archives.ArchiveTraversalOptions? = null
public static ArchiveTraversalResult TraverseZip(ZipArchive archive, ArchiveTraversalOptions? options, CancellationToken cancellationToken) #ArchiveTraversalResultTraverses an opened archive with bounded metadata processing and cooperative cancellation.
Parameters
- archive System.IO.Compression.ZipArchive
- options OfficeIMO.Archives.ArchiveTraversalOptions?
- cancellationToken System.Threading.CancellationToken
public static Void ValidateZipSource(Stream zipStream, ArchiveTraversalOptions? options = null, CancellationToken cancellationToken = default) #VoidValidates compressed size and physical entry count on a seekable ZIP source before opening a ZipArchive. The source position is restored. This check is safe only if the caller keeps the source bytes immutable until its archive has been read. Prefer a stream or path TraverseZip overload for mutable or untrusted sources.
Parameters
- zipStream System.IO.Stream
- options OfficeIMO.Archives.ArchiveTraversalOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?