pdcomm::startFormattedProgramExecution

Function

Starts an execution of the selected program and returns its start action.

inline GemFormattedProgramExecutionStart startFormattedProgramExecution(GemEquipment &endpoint, const GemFormattedProgramSelectionToken &selection, const GemFormattedProgramDryRunReport &report)

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

The selection must still be ready, and report must be a dry run of that selection with an unchanged capability catalog and an outcome other than reject. Only one execution can be active. Calling it again with the same selection and report while the start is pending returns the same start action. The library performs no equipment I/O; the state becomes ..._START_PENDING until the application resolves the start action.

Parameters

Name	Description
endpoint	Equipment endpoint with formatted program requests configured.
selection	Token returned by selectFormattedProgram().
report	Dry-run report of that selection.

Returns

The execution token and the start action.

Notes

• Throws pdcomm::Error: PDCOMM_INVALID_STATE when another execution is active, the dry run rejected the program, or the session is disconnected; PDCOMM_STALE_TOKEN when the selection, capability catalog, policy or program no longer match; PDCOMM_LIMIT_EXCEEDED when execution limits are exceeded.