JobStep Members
The JobStep class represents a Microsoft SQL Server job step.
The following tables list the members exposed by the JobStep type.
Public Constructors
| Name | Description | |
|---|---|---|
| JobStep | Overloaded. Initializes a new instance of the JobStep object. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms219040.protfield(en-US,SQL.90).gif") |
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms219040.pubproperty(en-US,SQL.90).gif") |
Command | Gets or sets the command execution string for the job step. |
|
CommandExecutionSuccessCode | Gets or sets the process exit code from a command shell process executed as a job step. |
|
DatabaseName | Gets or sets the name of the database to which the job step command execution is confined. |
|
DatabaseUserName | Gets or sets the database user account that the job step assumes when executing the command string. |
|
ID | Gets or sets the ID value that uniquely identifies the job step. |
|
JobStepFlags | The JobStepFlags property is reserved for future use. |
|
LastRunDate | Gets the date and time when the job step was last executed. |
|
LastRunDuration | Gets the time, in seconds, the referenced job step took to run when it was last executed. |
|
LastRunOutcome | Gets the outcome of the job step when it was last executed. |
|
LastRunRetries | Gets the number of retries that were attempted when the job step was last executed. |
|
Name | Gets or sets the name of the object. (inherited from NamedSmoObject) |
|
OnFailAction | Gets or sets the action to take when the job step finishes execution with failure. |
|
OnFailStep | Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure. |
|
OnSuccessAction | Gets or sets the action to take when the job step finishes execution with success. |
|
OnSuccessStep | Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success. |
|
OSRunPriority | Gets or sets the execution thread scheduling for job steps executing operating system tasks. |
|
OutputFileName | Gets or sets the name and path of the operating system file that records job step result message text. |
|
Parent | Gets or sets the Job object that is the parent of the JobStep object. |
|
Properties | Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject) |
|
ProxyName | Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step. |
|
RetryAttempts | Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure. |
|
RetryInterval | Gets or sets the number of minutes that Microsoft SQL Server Agent waits before trying to execute a job step that has previously failed. |
|
Server | Gets or sets the name of the server on which the job step runs. |
|
State | Gets the state of the referenced object. (inherited from SmoObjectBase) |
|
SubSystem | Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text. |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms219040.protproperty(en-US,SQL.90).gif") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) |
|
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) |
|
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms219040.pubmethod(en-US,SQL.90).gif") |
Alter | Updates any JobStep object property changes on instance of Microsoft SQL Server. |
|
Create | Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object. |
|
DeleteLogs | Overloaded. Deletes job step log files. |
|
Drop | Removes the referenced job step. |
|
EnumLogs | Returns an enumerated list of the job step log files. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) |
.gif "ms219040.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (inherited from SqlSmoObject) |
|
Rename | Renames the job step. |
|
Script | Overloaded. Generates a Transact-SQL script that can be used to re-create the job step. |
|
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms219040.protmethod(en-US,SQL.90).gif") |
AlterImpl | (inherited from SqlSmoObject ) |
|
AlterImplFinish | (inherited from SqlSmoObject ) |
|
AlterImplInit | (inherited from SqlSmoObject ) |
|
AlterImplWorker | (inherited from SqlSmoObject ) |
|
BindDefaultImpl | (inherited from SqlSmoObject ) |
|
BindRuleImpl | (inherited from SqlSmoObject ) |
|
CheckCollation | (inherited from SqlSmoObject ) |
|
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) |
|
CheckObjectStateImpl | (inherited from SqlSmoObject ) |
|
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) |
|
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) |
|
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) |
|
CheckVersionBelow90 | (inherited from SqlSmoObject ) |
|
CleanObject | (inherited from SqlSmoObject ) |
|
CreateImpl | (inherited from SqlSmoObject ) |
|
CreateImplFinish | (inherited from SqlSmoObject ) |
|
CreateImplInit | (inherited from SqlSmoObject ) |
|
DropImpl | (inherited from SqlSmoObject ) |
|
DropImplWorker | (inherited from SqlSmoObject ) |
|
Finalize | (inherited from Object ) |
|
FormatSqlVariant | (inherited from SqlSmoObject ) |
|
GenerateDataSpaceScript | (inherited from SqlSmoObject ) |
|
GetBindDefaultScript | (inherited from SqlSmoObject ) |
|
GetBindRuleScript | (inherited from SqlSmoObject ) |
|
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetDateTimeParameter | (inherited from SqlSmoObject ) |
|
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) |
|
GetDBName | Gets the database name that is associated with the object. (inherited from AgentObjectBase) |
|
GetEnumParameter | (inherited from SqlSmoObject ) |
|
GetFragOptionString | (inherited from SqlSmoObject ) |
|
GetGuidParameter | (inherited from SqlSmoObject ) |
|
GetParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetPropValue | (inherited from SqlSmoObject ) |
|
GetPropValueOptional | (inherited from SqlSmoObject ) |
|
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) |
|
GetRealValue | (inherited from SqlSmoObject ) |
|
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) |
|
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) |
|
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) |
|
ImplInitialize | (inherited from SqlSmoObject ) |
|
IsCollectionDirty | (inherited from SqlSmoObject ) |
|
IsObjectDirty | Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (inherited from SqlSmoObject) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsVersion80SP3 | (inherited from SqlSmoObject ) |
|
MarkDropped | (inherited from SqlSmoObject ) |
|
MarkForDropImpl | (inherited from SqlSmoObject ) |
|
MemberwiseClone | (inherited from Object ) |
|
PostAlter | (inherited from SqlSmoObject ) |
|
PostCreate | (inherited from SqlSmoObject ) |
|
PostDrop | (inherited from SqlSmoObject ) |
|
RenameImpl | (inherited from NamedSmoObject ) |
|
RenameImplWorker | (inherited from NamedSmoObject ) |
|
ScriptAlter | (inherited from SqlSmoObject ) |
|
ScriptChangeOwner | (inherited from NamedSmoObject ) |
|
ScriptCreate | (inherited from SqlSmoObject ) |
|
ScriptDdl | (inherited from SqlSmoObject ) |
|
ScriptDrop | (inherited from SqlSmoObject ) |
|
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) |
|
ScriptImplWorker | (inherited from SqlSmoObject ) |
|
ScriptRename | (inherited from NamedSmoObject ) |
|
SetParentImpl | (inherited from SqlSmoObject ) |
|
Trace | (inherited from SqlSmoObject ) |
|
UnbindDefaultImpl | (inherited from SqlSmoObject ) |
|
UnbindRuleImpl | (inherited from SqlSmoObject ) |
|
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
JobStep Class
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)