pdcomm::clearFormattedProgramSelection

Function

Clears the current selection when token matches it.

inline bool clearFormattedProgramSelection(GemEquipment &endpoint, const GemFormattedProgramSelectionToken &token)

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

Name	Description
`endpoint`	Equipment endpoint with formatted program requests configured.
`token`	Token of the current selection. A default (all-zero) token is accepted when nothing is selected.

true when a selection was cleared; false when nothing was selected.

Throws pdcomm::Error: PDCOMM_STALE_TOKEN when token does not match the current selection; PDCOMM_INVALID_STATE on a host or without a store.