Break

Interrupts a running command. This is a special command string with which the currently executing command name in /Execute/Command can be overridden. Not all commands support cancellation. If a command does not support Break, it will just proceed and terminate normally. If a command supports Break you might stop its execution by replacing the command name in the Command node by “Break”. As for normal commands, the Command node will be reset to Null after the operation is finally canceled. There are three cases how Break might terminate a running command, depending on the exact timing:

• Break was issued while the previous command was still running: The running command will terminate with the error OperationCanceled.

• Break was issued when the command has already completed its major operation and cannot be canceled anymore. The running command will complete normally.

• Break was issued right after the the running command has finished: The Break command will silently finish, resetting the result to Null .

The application issuing a Break command should not rely on a specific outcome or timing and explicitly check which of the three timings occurred.

Break can interrupt the following commands:

• Calibrate

• CalibrateHandEye

• Capture

• FitPrimitive

• Retrieve

Error Symbols

OperationCanceled

The operation was cancelled by the Break command, this is the normal termination if a command was interupted by Break.