Click or drag to resize

TaskManagerCancelActiveTask Method

Attempts to send a cancel signal to an active task.

Namespace:  MFiles.VAF.AppTasks
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.3.623.2
Syntax
public void CancelActiveTask(
	Vault vault,
	string taskId,
	string reason = null
)

Parameters

vault
Type: Vault
The vault instance to cancel with. If it is transaction bound (not permanent) the cancellation will only be signaled after the transaction succeeds. Otherwise the signal will be sent immediately.
taskId
Type: SystemString
The id of the task to cancel.
reason (Optional)
Type: SystemString
The reason for the cancellation.
See Also