PDComm.GemFormattedProgramExecutionToken

Class

Identifies one formatted process program execution of an equipment endpoint.

public sealed record GemFormattedProgramExecutionToken

GemFormattedPrograms.StartExecution returns it in GemFormattedProgramExecutionStart.Token. Pass it to GemFormattedPrograms.StepExecution, GemFormattedPrograms.CancelExecution and GemFormattedPrograms.CompleteExecution; a token that does not identify the current execution fails with PdcommStatus.StaleToken.

Parameters

Name	Description
`EndpointId`	The process-local identity of the endpoint that started the execution.
`SessionGeneration`	The connection generation in which the execution started.
`ExecutionGeneration`	The execution number; each start of a new execution increases it by one.

Members

`GemFormattedProgramExecutionToken`

Constructor

Identifies one formatted process program execution of an equipment endpoint.

public GemFormattedProgramExecutionToken(ulong EndpointId, ulong SessionGeneration, ulong ExecutionGeneration)

Parameters

Name	Description
`EndpointId`	The process-local identity of the endpoint that started the execution.
`SessionGeneration`	The connection generation in which the execution started.
`ExecutionGeneration`	The execution number; each start of a new execution increases it by one.

`EndpointId`

Property

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

public ulong EndpointId { get; init; }

`ExecutionGeneration`

Property

The execution number; each start of a new execution increases it by one.

public ulong ExecutionGeneration { get; init; }

`SessionGeneration`

Property

The connection generation in which the execution started.

public ulong SessionGeneration { get; init; }