pdcomm::cancelFormattedProgramExecution

Function

Requests cancellation of a running execution as a cancel action.

inline GemFormattedProgramExecutionAction cancelFormattedProgramExecution(GemEquipment &endpoint, const GemFormattedProgramExecutionToken &token)

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

The state becomes ..._CANCEL_PENDING. While a cancel is pending, calling it again returns the same cancel action.

Parameters

Name	Description
endpoint	Equipment endpoint that runs the execution.
token	Token of the execution.

Returns

The cancel action.

Notes

• Throws pdcomm::Error: PDCOMM_INVALID_STATE when the execution is not running; PDCOMM_STALE_TOKEN for a stale token.