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
Public Property CommandExecutionSuccessCode As Integer

public int CommandExecutionSuccessCode { get; set; }

public:
property int CommandExecutionSuccessCode {
    int get ();
    void set (int value);
}

/** @property */
public int get_CommandExecutionSuccessCode ()

/** @property */
public void set_CommandExecutionSuccessCode (int value)

public function get CommandExecutionSuccessCode () : int

public function set CommandExecutionSuccessCode (value : int)

Property Value

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

Remarks

Updated text:

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.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Create a Job with Steps and a Schedule in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

JobStep Class
JobStep Members
Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Scheduling Automatic Administrative Tasks in SQL Server Agent
Automating Administrative Tasks (SQL Server Agent)
sp_help_jobstep (Transact-SQL)

Change History