cancel

<< Click to Display Table of Contents >>

Navigation:  NxLib API > C++ Interface > NxLibCommand >

cancel

Cancels the command by using the Break command.

Signatures

Error handling via exception:

void cancel(bool wait = true)

Note: When wait is set to true, this method ignores all errors from the command.

Error handling via return code:

void cancel(int* returnCode, bool wait = true)

Parameters

returnCode

The API return code.

wait

Specifies whether canceling the command should be carried out synchronously (i.e. the function waits for the execution of cmdBreak to finish), or whether the function should return after starting the command execution. If this parameter is false, you can use the finished method to check whether the operation is still running.

Return Value

none