SteppablePipeline.Clean Method

Definition

Clean resources for script commands of this steppable pipeline.

public void Clean ();
member this.Clean : unit -> unit
Public Sub Clean ()

Remarks

The way we handle 'Clean' blocks in a steppable pipeline makes sure that: 1. The 'Clean' blocks get to run if any exception is thrown from 'Begin/Process/End'. 2. The 'Clean' blocks get to run if 'End' finished successfully. However, this is not enough for a steppable pipeline, because the function, where the steppable pipeline gets used, may fail (think about a proxy function). And that may lead to the situation where "no exception was thrown from the steppable pipeline" but "the steppable pipeline didn't run to the end". In that case, 'Clean' won't run unless it's triggered explicitly on the steppable pipeline. This method allows a user to do that from the 'Clean' block of the proxy function.

Applies to