JobStep.SubSystem Property
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
<SfcPropertyAttribute> _
Public Property SubSystem As AgentSubSystem
Get
Set
'Usage
Dim instance As JobStep
Dim value As AgentSubSystem
value = instance.SubSystem
instance.SubSystem = value
[SfcPropertyAttribute]
public AgentSubSystem SubSystem { get; set; }
[SfcPropertyAttribute]
public:
property AgentSubSystem SubSystem {
AgentSubSystem get ();
void set (AgentSubSystem value);
}
[<SfcPropertyAttribute>]
member SubSystem : AgentSubSystem with get, set
function get SubSystem () : AgentSubSystem
function set SubSystem (value : AgentSubSystem)
Property Value
Type: Microsoft.SqlServer.Management.Smo.Agent.AgentSubSystem
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.