CompoundFileOptions Class

Definition

Namespace

Bodu.IO.Compound

Assembly

Bodu.IO.Compound.dll

Package

Bodu.IO.Compound 1.0.0

Source

CompoundFileOptions.cs

Specifies options that control how a CompoundFile is opened for reading.

public sealed class CompoundFileOptions

Inheritance

object

CompoundFileOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

The default instance buffers the whole file into memory and validates it at Compatible, matching the behavior of the parameterless read overloads.

Constructors

CompoundFileOptions()

public CompoundFileOptions()

Properties

Default

Gets a shared CompoundFileOptions instance carrying the default values.

public static CompoundFileOptions Default { get; }

Property Value

CompoundFileOptions

The default options.

MaxBufferedBytes

Gets or sets the size threshold, in bytes, above which a seekable source is read on demand.

public long MaxBufferedBytes { get; set; }

Property Value

long

Only consulted when ReadStrategy is Auto.

ReadStrategy

Gets or sets the strategy used to source the file's bytes.

public CompoundReadStrategy ReadStrategy { get; set; }

Property Value

CompoundReadStrategy

The configured CompoundReadStrategy; Buffered by default.

ValidationLevel

Gets or sets how strictly the container's structure is validated.

public CompoundValidationLevel ValidationLevel { get; set; }

Property Value

CompoundValidationLevel

The configured CompoundValidationLevel; Compatible by default.

Applies to

Product	Versions
.NET	8, 10