SetStepOutcome Method (ScriptHostInterface)

In This Topic

Sets the success or failure state of the step in which the script is executing

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Shared Sub SetStepOutcome( _
   ByVal outcome As ExecutionOutcome, _
   Optional ByVal message As String _
)

public static void SetStepOutcome( 
   ExecutionOutcome outcome,
   string message
)

public:
static void SetStepOutcome( 
   ExecutionOutcome outcome,
   String^ message
)

Parameters

outcome: Indicates whether the step should be reported as Succeeded or Failed.
message: Optional message to log to the Job Log

Remarks

When the outcome is set using SetStepOutcome, this overrides the normal success/failure determination rules for the step. This is equivalent to using a JobControlAction with a ControlType of SucceedJob or FailJob

Reference

ScriptHostInterface Class
ScriptHostInterface Members