PDComm.GemFormattedProgramExecutionActionInfo

Class

Describes an action that a formatted process program execution asks the application to perform.

public sealed record GemFormattedProgramExecutionActionInfo

Returned by GemFormattedProgramExecutionAction.GetInfo. A start action carries the program ID, model and software revision; a step action carries one command; a cancel action carries the index of the next command that was not applied. GemFormattedProgramExecutionActionInfo.PresenceMask tells which of these fields apply; the fields of the other kinds are 0.

Parameters

Name	Description
Kind	The action kind: 1 start, 2 step or 3 cancel.
PresenceMask	Bit flags: 1 program ID, 2 model and 4 software revision for a start action, 8 command for a step action, 16 GemFormattedProgramExecutionActionInfo.CancelNextCommandIndex for a cancel action.
DryRunOutcome	For a start action, the GemFormattedProgramDryRunOutcome code of the dry run that admitted the execution.
PolicyVersion	For a start action, the dry run policy version.
IdFormat	For a start action, the SECS-II format code of the program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
CodeFormat	For a step action, the SECS-II format code of the command code (CCODE): 16 ASCII, or 41, 42, 44 or 40 for U1, U2, U4 or U8; see SecsFormat.
EndpointId	The process-local identity of the endpoint that runs the execution.
SessionGeneration	The connection generation in which the execution started.
ExecutionGeneration	The execution number of the execution the action belongs to.
ActionSequence	The sequence number of the action within its execution; the start action is 1.
CapabilityRevision	For a start action, the capability catalog revision of the dry run.
CommandIndex	For a step action, the zero-based index of the command to perform.
CommandCount	The number of commands in the executed program.
ParameterCount	For a step action, the number of parameters of the command.
CancelNextCommandIndex	For a cancel action, the zero-based index of the next command that had not been applied when the cancellation was requested.

Members

GemFormattedProgramExecutionActionInfo

Constructor

Describes an action that a formatted process program execution asks the application to perform.

public GemFormattedProgramExecutionActionInfo(uint Kind, uint PresenceMask, uint DryRunOutcome, uint PolicyVersion, byte IdFormat, byte CodeFormat, ulong EndpointId, ulong SessionGeneration, ulong ExecutionGeneration, ulong ActionSequence, ulong CapabilityRevision, nuint CommandIndex, nuint CommandCount, nuint ParameterCount, nuint CancelNextCommandIndex)

Returned by GemFormattedProgramExecutionAction.GetInfo. A start action carries the program ID, model and software revision; a step action carries one command; a cancel action carries the index of the next command that was not applied. GemFormattedProgramExecutionActionInfo.PresenceMask tells which of these fields apply; the fields of the other kinds are 0.

Parameters

Name	Description
Kind	The action kind: 1 start, 2 step or 3 cancel.
PresenceMask	Bit flags: 1 program ID, 2 model and 4 software revision for a start action, 8 command for a step action, 16 GemFormattedProgramExecutionActionInfo.CancelNextCommandIndex for a cancel action.
DryRunOutcome	For a start action, the GemFormattedProgramDryRunOutcome code of the dry run that admitted the execution.
PolicyVersion	For a start action, the dry run policy version.
IdFormat	For a start action, the SECS-II format code of the program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
CodeFormat	For a step action, the SECS-II format code of the command code (CCODE): 16 ASCII, or 41, 42, 44 or 40 for U1, U2, U4 or U8; see SecsFormat.
EndpointId	The process-local identity of the endpoint that runs the execution.
SessionGeneration	The connection generation in which the execution started.
ExecutionGeneration	The execution number of the execution the action belongs to.
ActionSequence	The sequence number of the action within its execution; the start action is 1.
CapabilityRevision	For a start action, the capability catalog revision of the dry run.
CommandIndex	For a step action, the zero-based index of the command to perform.
CommandCount	The number of commands in the executed program.
ParameterCount	For a step action, the number of parameters of the command.
CancelNextCommandIndex	For a cancel action, the zero-based index of the next command that had not been applied when the cancellation was requested.

ActionSequence

Property

The sequence number of the action within its execution; the start action is 1.

public ulong ActionSequence { get; init; }

CancelNextCommandIndex

Property

For a cancel action, the zero-based index of the next command that had not been applied when the cancellation was requested.

public nuint CancelNextCommandIndex { get; init; }

CapabilityRevision

Property

For a start action, the capability catalog revision of the dry run.

public ulong CapabilityRevision { get; init; }

CodeFormat

Property

For a step action, the SECS-II format code of the command code (CCODE): 16 ASCII, or 41, 42, 44 or 40 for U1, U2, U4 or U8; see SecsFormat.

public byte CodeFormat { get; init; }

CommandCount

Property

The number of commands in the executed program.

public nuint CommandCount { get; init; }

CommandIndex

Property

For a step action, the zero-based index of the command to perform.

public nuint CommandIndex { get; init; }

DryRunOutcome

Property

For a start action, the GemFormattedProgramDryRunOutcome code of the dry run that admitted the execution.

public uint DryRunOutcome { get; init; }

EndpointId

Property

The process-local identity of the endpoint that runs the execution.

public ulong EndpointId { get; init; }

ExecutionGeneration

Property

The execution number of the execution the action belongs to.

public ulong ExecutionGeneration { get; init; }

IdFormat

Property

For a start action, the SECS-II format code of the program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).

public byte IdFormat { get; init; }

Kind

Property

The action kind: 1 start, 2 step or 3 cancel.

public uint Kind { get; init; }

ParameterCount

Property

For a step action, the number of parameters of the command.

public nuint ParameterCount { get; init; }

PolicyVersion

Property

For a start action, the dry run policy version.

public uint PolicyVersion { get; init; }

PresenceMask

Property

Bit flags: 1 program ID, 2 model and 4 software revision for a start action, 8 command for a step action, 16 GemFormattedProgramExecutionActionInfo.CancelNextCommandIndex for a cancel action.

public uint PresenceMask { get; init; }

SessionGeneration

Property

The connection generation in which the execution started.

public ulong SessionGeneration { get; init; }