SubSystem Property
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The SubSystem property specifies the SQL Server Agent execution subsystem used to interpret job step task-defining text.
Syntax
object
.SubSystem [=value]
Parts
- object
An expression that evaluates to an object in the Applies To list.
- value
A string that identifies an existing SQL Server Agent job step subsystem by name. TSQL is the default.
Data Type
String
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetSubSystem(SQLDMO_LPBSTR pRetVal);
HRESULT SetSubSystem(SQLDMO_LPCSTR NewValue);
Note
SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.
Remarks
Most commonly, a job step uses the ActiveScripting, CmdExec, or TSQL subsystem. Other job step subsystems exist. Job step subsystem names can be enumerated using the EnumSubSystems method.
When SQL-DMO is used to create or modify 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, if SubSystem is TSQL, Transact-SQL is used in the task-defining text specified using the Command property, and the DatabaseName and DatabaseUserName properties are applicable. If SubSystem is CmdExec, an operating system command is specified using the Command property, and the CmdExecSuccessCode and OSRunPriority properties are applicable.