Share via

JobStep.SubSystem Property

  • Article

Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.

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

Syntax

'Declaration
Public Property SubSystem As AgentSubSystem

public AgentSubSystem SubSystem { get; set; }

public:
property AgentSubSystem SubSystem {
    AgentSubSystem get ();
    void set (AgentSubSystem value);
}

/** @property */
public AgentSubSystem get_SubSystem ()

/** @property */
public void set_SubSystem (AgentSubSystem value)

public function get SubSystem () : AgentSubSystem

public function set SubSystem (value : AgentSubSystem)

Property Value

A string value that specifies the SQL Server Agent subsystem used to interpret the job step command text.

Remarks

Typically, a job step uses either the command shell (CmdExec), or TSQL subsystem. Other job step subsystems exist. Job step subsystem names can be enumerated using the EnumSubSystems method.

When creating or modifying SQL Server Agent jobs, the job step execution subsystem chosen using the SubSystem property defines applicability and interpretation of other properties of the JobStep object.

For example, when SubSystem is TSQL, Transact-SQL is used in the task-defining text specified by using the Command property, and the DatabaseName and DatabaseUserName properties are applicable. When SubSystem is CmdExec, an operating system command is specified by using the Command property, and the CommandExecutionSuccessCode and OSRunPriority properties are applicable.

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)