Struct HostWindowResult

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One outcome from an IHostWindow call. Notice carries a one-line reason when the host has one worth surfacing (a logger message, a diagnostic panel) -- callers should branch on Status/Succeeded only, never on the text of Notice, which is not a stable identifier.

public readonly record struct HostWindowResult : IEquatable<HostWindowResult>

Implements

IEquatable<HostWindowResult>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

HostWindowResult(HostWindowStatus, string?)

One outcome from an IHostWindow call. Notice carries a one-line reason when the host has one worth surfacing (a logger message, a diagnostic panel) -- callers should branch on Status/Succeeded only, never on the text of Notice, which is not a stable identifier.

public HostWindowResult(HostWindowStatus Status, string? Notice = null)

Parameters

Status HostWindowStatus

Notice string

Properties

Notice

public string? Notice { get; init; }

Property Value

string

Status

public HostWindowStatus Status { get; init; }

Property Value

HostWindowStatus

Succeeded

Whether the operation took effect.

public bool Succeeded { get; }

Property Value

bool