SubSystem Property
The SubSystem property specifies the Microsoft® SQL Server™ 2000 Agent execution subsystem used to interpret job step task-defining text.
Applies To
| JobStep Object |
Syntax
object.SubSystem [= value]
Parts
object
Expression that evaluates to an object in the Applies To list
value
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-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 will use either the ActiveScripting, CmdExec, or TSQL subsystem. Other job step subsystems exist. Job step subsystem names can be enumerated using the EnumSubSystems method.
When using SQL-DMO 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, when 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. When SubSystem is CmdExec, an operating system command is specified using the Command property, and the CmdExecSuccessCode and OSRunPriority properties are applicable.