pdcomm::submitFormattedProgramExecutionActionResult

Function

Reports what the application did with a requested action.

inline void submitFormattedProgramExecutionActionResult(GemEquipment &endpoint, const GemFormattedProgramExecutionActionToken &token, uint32_t result)

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

Valid results per action kind (PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_*): start accepts ..._ACCEPTED; step accepts ..._APPLIED; cancel accepts ..._CANCELLED; every kind also accepts ..._REJECTED, ..._FAILED and ..._OUTCOME_UNKNOWN. Accepted and applied keep the execution running; a rejected cancel also resumes running. Repeating the same result is accepted; a different result for the same action is not.

Parameters

Name	Description
endpoint	Equipment endpoint that runs the execution.
token	Token from GemFormattedProgramExecutionAction::token().
result	Result code for the action.

Notes

• Throws pdcomm::Error: PDCOMM_INVALID_ARGUMENT for a result that does not fit the action kind; PDCOMM_STALE_TOKEN for a stale action or a conflicting repeated result.