CancelSample() method
- Last UpdatedNov 26, 2024
- 1 minute read
Use the CancelSample() method to cancel the currently selected sample. The CancelSampleEnabled property must be set to True for this method to be successful.
The Sample Viewer calls the Cancel() method in the Sample class in the Stateless API to cancel the sample. If the API method returns an error, the error is displayed to the user after it has been translated into the user’s language. If the API method successfully cancels the sample, the Sample Viewer updates the display.
Syntax
CancelSample();