Share via


JobStep.CommandExecutionSuccessCode Property

Gets or sets the process exit code from a command shell process executed as a job step.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property CommandExecutionSuccessCode As Integer 
    Get 
    Set
'Usage
Dim instance As JobStep 
Dim value As Integer 

value = instance.CommandExecutionSuccessCode

instance.CommandExecutionSuccessCode = value
[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public int CommandExecutionSuccessCode { get; set; }
[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property int CommandExecutionSuccessCode {
    int get ();
    void set (int value);
}
[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member CommandExecutionSuccessCode : int with get, set
function get CommandExecutionSuccessCode () : int 
function set CommandExecutionSuccessCode (value : int)

Property Value

Type: System.Int32
A Int32 value that specifies the command execution success code; 0 is success, and 1 is failure.

Remarks

A job step that executes a command shell process relies on the process exit code to determine the success or failure of the job step. Set the CommandExecutionSuccessCode property to the successful return code of a command shell process to enable logic and notifications based on the success or failure of the job step.

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

See Also

Reference

JobStep Class

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_help_jobstep (Transact-SQL)