BiffCodePageRecord Struct

Definition

Namespace

Bodu.IO.Biff

Assembly

Bodu.IO.Biff.dll

Package

Bodu.IO.Biff 1.0.0

Source

BiffCodePageRecord.cs

Represents a decoded CODEPAGE record: the code page byte strings in the stream are encoded in.

public readonly struct BiffCodePageRecord : IEquatable<BiffCodePageRecord>

Implements

IEquatable<BiffCodePageRecord>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

BufferConverter.CopyTo<T>(T, byte[], int)

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

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

ComparableExtensions.Clamp<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsBetween<T>(T, T?, T?, IComparer<T>)

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

ComparableExtensions.IsGreaterThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsGreaterThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsOutside<T>(T, T?, T?, IComparer<T>)

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

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

Remarks

The record identifier is CodePage. The payload is a single 16-bit value in both versions. Reading the record also updates CodePage, so the byte strings that follow decode with it; CodePage exposes the normalized Windows code page number.

Constructors

BiffCodePageRecord(ushort)

Represents a decoded CODEPAGE record: the code page byte strings in the stream are encoded in.

public BiffCodePageRecord(ushort RawValue)

Parameters

RawValue ushort

The value as stored, including the private markers for Apple Roman (0x8000) and the legacy ANSI page (0x8001).

Remarks

The record identifier is CodePage. The payload is a single 16-bit value in both versions. Reading the record also updates CodePage, so the byte strings that follow decode with it; CodePage exposes the normalized Windows code page number.

See Also

GetCodePage()

CodePage

WriteCodePage(ushort)

CodePage

Properties

CodePage

Gets the Windows code page number the value denotes.

public int CodePage { get; }

Property Value

int

The normalized code page; 1200 denotes UTF-16LE text in a BIFF8 stream.

RawValue

The value as stored, including the private markers for Apple Roman (0x8000) and the legacy ANSI page (0x8001).

public ushort RawValue { get; init; }

Property Value

ushort

Methods

Deconstruct(out ushort)

public void Deconstruct(out ushort RawValue)

Parameters

RawValue ushort

Equals(BiffCodePageRecord)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(BiffCodePageRecord other)

Parameters

other BiffCodePageRecord

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(BiffCodePageRecord, BiffCodePageRecord)

public static bool operator ==(BiffCodePageRecord left, BiffCodePageRecord right)

Parameters

left BiffCodePageRecord

right BiffCodePageRecord

Returns

bool

operator !=(BiffCodePageRecord, BiffCodePageRecord)

public static bool operator !=(BiffCodePageRecord left, BiffCodePageRecord right)

Parameters

left BiffCodePageRecord

right BiffCodePageRecord

Returns

bool

Applies to

Product	Versions
.NET	8, 10

See Also

GetCodePage()

CodePage

WriteCodePage(ushort)

CodePage