BiffBoolErrRecord Struct

Definition

Namespace

Bodu.IO.Biff

Assembly

Bodu.IO.Biff.dll

Package

Bodu.IO.Biff 1.0.0

Source

BiffBoolErrRecord.cs

Represents a decoded BOOLERR record: a cell holding either a boolean or an error code.

public readonly struct BiffBoolErrRecord : IEquatable<BiffBoolErrRecord>

Implements

IEquatable<BiffBoolErrRecord>

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 BoolErr. The payload is eight bytes in both versions: the cell prefix, the value byte, and a kind byte that is zero for a boolean and non-zero for an error code.

Constructors

BiffBoolErrRecord(int, int, ushort, byte, bool)

Represents a decoded BOOLERR record: a cell holding either a boolean or an error code.

public BiffBoolErrRecord(int Row, int Column, ushort XfIndex, byte RawValue, bool IsError)

Parameters

Row int

The zero-based row index.

Column int

The zero-based column index.

XfIndex ushort

The extended-format index of the cell.

RawValue byte

The value byte: zero or one for a boolean, the error code otherwise.

IsError bool

Whether RawValue is an error code rather than a boolean.

Remarks

The record identifier is BoolErr. The payload is eight bytes in both versions: the cell prefix, the value byte, and a kind byte that is zero for a boolean and non-zero for an error code.

See Also

GetBoolErr()

WriteBoolean(int, int, ushort, bool)

WriteError(int, int, ushort, byte)

WriteBoolErr(int, int, ushort, byte, bool)

Properties

BooleanValue

Gets a value indicating whether the cell holds true.

public bool BooleanValue { get; }

Property Value

bool

true when the value byte is non-zero; meaningful only when IsError is false.

Column

The zero-based column index.

public int Column { get; init; }

Property Value

int

ErrorCode

Gets the error code of the cell.

public byte ErrorCode { get; }

Property Value

byte

The BIFF error code (0x00 #NULL!, 0x07 #DIV/0!, 0x0F #VALUE!, 0x17 #REF!, 0x1D #NAME?, 0x24 #NUM!, 0x2A #N/A); meaningful only when IsError is true.

IsError

Whether RawValue is an error code rather than a boolean.

public bool IsError { get; init; }

Property Value

bool

RawValue

The value byte: zero or one for a boolean, the error code otherwise.

public byte RawValue { get; init; }

Property Value

byte

Row

The zero-based row index.

public int Row { get; init; }

Property Value

int

XfIndex

The extended-format index of the cell.

public ushort XfIndex { get; init; }

Property Value

ushort

Methods

Deconstruct(out int, out int, out ushort, out byte, out bool)

public void Deconstruct(out int Row, out int Column, out ushort XfIndex, out byte RawValue, out bool IsError)

Parameters

Row int

Column int

XfIndex ushort

RawValue byte

IsError bool

Equals(BiffBoolErrRecord)

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

public bool Equals(BiffBoolErrRecord other)

Parameters

other BiffBoolErrRecord

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 ==(BiffBoolErrRecord, BiffBoolErrRecord)

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

Parameters

left BiffBoolErrRecord

right BiffBoolErrRecord

Returns

bool

operator !=(BiffBoolErrRecord, BiffBoolErrRecord)

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

Parameters

left BiffBoolErrRecord

right BiffBoolErrRecord

Returns

bool

Applies to

Product	Versions
.NET	8, 10

See Also

GetBoolErr()

WriteBoolean(int, int, ushort, bool)

WriteError(int, int, ushort, byte)

WriteBoolErr(int, int, ushort, byte, bool)