PDComm.GemSpoolWriteResult

Struct

Represents the outcome of an equipment spool operation that can change the spool.

public readonly record struct GemSpoolWriteResult

When nothing changed, for example when a captured message was not selected or a synchronization activated nothing, GemSpoolWriteResult.Applied is false, GemSpoolWriteResult.Mutation is GemSpoolMutation.None and GemSpoolWriteResult.Durability is GemSpoolDurability.None.

Parameters

Name	Description
`Status`	`PdcommStatus.Ok`, or `PdcommStatus.SpoolUnconfirmed` when the change was installed but its persistence could not be confirmed. Other statuses are thrown as `PdcommException`.
`Mutation`	The change that was installed.
`Durability`	How durably the change was stored.
`PersistenceStatus`	The `PdcommStatus` value of the persistence failure when `Durability` is `GemSpoolDurability.Unconfirmed`; otherwise 0.
`EntryId`	The ID of the captured or removed entry; otherwise 0.
`AffectedCount`	The number of entries overwritten by a capture, removed by a purge, or 1 for a dequeue; otherwise 0.
`Applied`	`true` when a change was installed.
`Selected`	`true` when a change was installed; `false` when a captured message was not selected for spooling.

Members

`GemSpoolWriteResult`

Constructor

Represents the outcome of an equipment spool operation that can change the spool.

public GemSpoolWriteResult(PdcommStatus Status, GemSpoolMutation Mutation, GemSpoolDurability Durability, int PersistenceStatus, ulong EntryId, nuint AffectedCount, bool Applied, bool Selected)

Parameters

Name	Description
`Status`	`PdcommStatus.Ok`, or `PdcommStatus.SpoolUnconfirmed` when the change was installed but its persistence could not be confirmed. Other statuses are thrown as `PdcommException`.
`Mutation`	The change that was installed.
`Durability`	How durably the change was stored.
`PersistenceStatus`	The `PdcommStatus` value of the persistence failure when `Durability` is `GemSpoolDurability.Unconfirmed`; otherwise 0.
`EntryId`	The ID of the captured or removed entry; otherwise 0.
`AffectedCount`	The number of entries overwritten by a capture, removed by a purge, or 1 for a dequeue; otherwise 0.
`Applied`	`true` when a change was installed.
`Selected`	`true` when a change was installed; `false` when a captured message was not selected for spooling.

`AffectedCount`

Property

The number of entries overwritten by a capture, removed by a purge, or 1 for a dequeue; otherwise 0.

public nuint AffectedCount { get; init; }

`Applied`

Property

true when a change was installed.

public bool Applied { get; init; }

`Durability`

Property

How durably the change was stored.

public GemSpoolDurability Durability { get; init; }

`EntryId`

Property

The ID of the captured or removed entry; otherwise 0.

public ulong EntryId { get; init; }

`Mutation`

Property

The change that was installed.

public GemSpoolMutation Mutation { get; init; }

`PersistenceStatus`

Property

The PdcommStatus value of the persistence failure when Durability is GemSpoolDurability.Unconfirmed; otherwise 0.

public int PersistenceStatus { get; init; }

`Selected`

Property

true when a change was installed; false when a captured message was not selected for spooling.

public bool Selected { get; init; }

`Status`

Property

PdcommStatus.Ok, or PdcommStatus.SpoolUnconfirmed when the change was installed but its persistence could not be confirmed. Other statuses are thrown as PdcommException.

public PdcommStatus Status { get; init; }