pdcomm::dryRunFormattedProgram
Function
Analyses the selected formatted program against the equipment's capability catalog.
inline GemFormattedProgramDryRunReport dryRunFormattedProgram(GemEquipment &endpoint, const GemFormattedProgramSelectionToken &token, const PdcommGemFormattedProgramDryRunOptions &options)The selection must still be ready (see validateFormattedProgramSelection()). Without a capability catalog the report contains a capability-missing finding and an indeterminate outcome.
Parameters
| Name | Description |
|---|---|
endpoint | Equipment endpoint with formatted program requests configured. |
token | Token returned by selectFormattedProgram(). |
options | Options built with gemFormattedProgramDryRunOptions(). |
Returns
An owned report.
Notes
- Throws
pdcomm::Error:PDCOMM_STALE_TOKENwhen the selection is cleared, different or stale;PDCOMM_INVALID_STATEon a host or without a store;PDCOMM_INVALID_ARGUMENTfor invalid options or an unsupported policy;PDCOMM_LIMIT_EXCEEDEDwhenmaxIssuesormaxProgramEncodedBytesis exceeded.