Table of Contents

CompoundBuildOptions Struct

Definition

Namespace
Bodu.IO.Compound.Builders
Assembly
Bodu.IO.Compound.dll
Package
Bodu.IO.Compound 1.3.0
Source
CompoundBuildOptions.cs

Specifies options that control how a CompoundStorageBuilder tree serializes a compound file.

public struct CompoundBuildOptions
Inherited Members
Extension Methods

Remarks

The default value (default) selects version 3 (512-byte sectors) and the default maximum nesting depth, producing the most widely compatible output. A Version that is neither the default nor a defined CompoundFileVersion is rejected with ArgumentOutOfRangeException by every serializer and by Create(Stream, bool, CompoundBuildOptions).

Properties

MaxDepth

Gets or sets the maximum storage nesting depth permitted while writing.

public int MaxDepth { readonly get; set; }

Property Value

int

The configured maximum depth, or 0 to use the built-in default.

Version

Gets or sets the compound-file format version to write.

public CompoundFileVersion Version { readonly get; set; }

Property Value

CompoundFileVersion

The target CompoundFileVersion; V3 when left at its default.

Remarks

Only the default and the defined CompoundFileVersion members are accepted; any other value makes the serializers and Create(Stream, bool, CompoundBuildOptions) throw ArgumentOutOfRangeException naming the options parameter, before anything is written.

Applies to

ProductVersions
.NET8, 10