JobStep Members

Include Protected Members
Include Inherited Members

The JobStep class represents a Microsoft SQL Server job step.

The JobStep type exposes the following members.

Constructors

	Name	Description
	JobStep()	Initializes a new instance of the JobStep class.
	JobStep(Job, String)	Initializes a new instance of the JobStep class for the specified job and with the specified name.

Top

Methods

	Name	Description
	AddDatabaseContext(StringCollection)	(Inherited from SqlSmoObject.)
	Alter()	Updates any JobStep object property changes on instance of Microsoft SQL Server.
	AlterImpl()	(Inherited from SqlSmoObject.)
	AlterImplFinish(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	AlterImplInit(StringCollection%, ScriptingOptions%)	(Inherited from SqlSmoObject.)
	AlterImplWorker()	(Inherited from SqlSmoObject.)
	BindDefaultImpl(String, String, Boolean)	(Inherited from SqlSmoObject.)
	BindRuleImpl(String, String, Boolean)	(Inherited from SqlSmoObject.)
	CheckCollation(String, ScriptingOptions)	(Inherited from SqlSmoObject.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from SqlSmoObject.)
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
	CheckObjectStateImpl(Boolean)	(Inherited from SqlSmoObject.)
	CheckVersion100()	(Inherited from SqlSmoObject.)
	CheckVersion80()	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3()	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90()	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow90()	(Inherited from SqlSmoObject.)
	CleanObject()	(Inherited from SqlSmoObject.)
	Create()	Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
	CreateImpl()	(Inherited from SqlSmoObject.)
	CreateImplFinish(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	CreateImplInit(StringCollection%, ScriptingOptions%)	(Inherited from SqlSmoObject.)
	DeleteLogs(DateTime)	Deletes job step log files that are older than the specified date.
	DeleteLogs(Int32)
	Discover()	(Inherited from SqlSmoObject.)
	Drop()	Removes the referenced job step.
	DropImpl()	(Inherited from SqlSmoObject.)
	DropImplWorker(Urn%)	(Inherited from SqlSmoObject.)
	EnumLogs()	Returns an enumerated list of the job step log files.
	EnumScriptImpl(ScriptingOptions)	(Inherited from SqlSmoObject.)
	EnumScriptImplWorker(ScriptingOptions)	(Inherited from SqlSmoObject.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	FormatSqlVariant(Object)	(Inherited from SqlSmoObject.)
	GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean)	(Inherited from SqlSmoObject.)
	GenerateDataSpaceScript(StringBuilder, ScriptingOptions)	(Inherited from SqlSmoObject.)
	GetBindDefaultScript(ScriptingOptions, String, String, Boolean)	(Inherited from SqlSmoObject.)
	GetBindRuleScript(ScriptingOptions, String, String, Boolean)	(Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetDBName()	Gets the database name that is associated with the object. (Inherited from AgentObjectBase.)
	GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%)	(Inherited from SqlSmoObject.)
	GetFragOptionString(FragmentationOption)	(Inherited from SqlSmoObject.)
	GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetHashCode()	(Inherited from Object.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetPropValue(String)	(Inherited from SqlSmoObject.)
	GetPropValueOptional(String)	(Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull(String)	(Inherited from SqlSmoObject.)
	GetRealValue(Property, Object)	(Inherited from SqlSmoObject.)
	GetScriptingOptionsForCreate()	(Inherited from SqlSmoObject.)
	GetServerName()	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject()	(Inherited from SqlSmoObject.)
	GetSqlServerVersionName()	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetType()	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	(Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	(Inherited from SqlSmoObject.)
	ImplInitialize(array<String[], array<OrderBy[])	(Inherited from SqlSmoObject.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectDirty()	Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of 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 SQL Server. (Inherited from SqlSmoObject.)
	IsVersion80SP3()	(Inherited from SqlSmoObject.)
	MarkDropped()	(Inherited from SqlSmoObject.)
	MarkForDropImpl(Boolean)	(Inherited from SqlSmoObject.)
	MemberwiseClone()	(Inherited from Object.)
	PostAlter()	(Inherited from SqlSmoObject.)
	PostCreate()	(Inherited from SqlSmoObject.)
	PostDrop()	(Inherited from SqlSmoObject.)
	Refresh()	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	Rename(String)	Renames the job step.
	RenameImpl(String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	RenameImplWorker(String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	Script()	Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step as specified by the scripting options.
	ScriptAlter(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptChangeOwner(StringCollection, ScriptingOptions)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	ScriptCreate(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptDdl(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptDrop(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptImpl()	(Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptImplWorker(ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptRename(StringCollection, ScriptingOptions, String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	SetParentImpl(SqlSmoObject)	(Inherited from SqlSmoObject.)
	ToString()	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl()	(Inherited from SqlSmoObject.)
	UnbindDefaultImpl(Boolean)	(Inherited from SqlSmoObject.)
	UnbindRuleImpl(Boolean)	(Inherited from SqlSmoObject.)
	Validate(String, array<Object[])	(Inherited from SmoObjectBase.)

Top

Fields

	Name	Description
	m_ExtendedProperties	(Inherited from SqlSmoObject.)

Top

Properties

	Name	Description
	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.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	ID	Gets or sets the ID value that uniquely identifies the job step.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	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.)
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	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.
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	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

Events

	Name	Description
	PropertyChanged	(Inherited from SqlSmoObject.)
	PropertyMetadataChanged	(Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObjectDiscover()	(Inherited from SqlSmoObject.)
	IAlienObjectGetParent()	(Inherited from SqlSmoObject.)
	IAlienObjectGetProperty(String)	(Inherited from SqlSmoObject.)
	ISfcPropertyProviderGetPropertySet()	(Inherited from SqlSmoObject.)
	IAlienObjectGetUrn()	(Inherited from SqlSmoObject.)
	IAlienObjectResolve(String)	(Inherited from SqlSmoObject.)
	IAlienObjectSetProperty(Object, Object)	(Inherited from SqlSmoObject.)

Top

See Also

Reference

JobStep Class

Microsoft.SqlServer.Management.Smo.Agent Namespace