项目
12/14/2010

JobStep 类

The JobStep class represents a Microsoft SQL Server job step.

继承层次结构

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
    Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
      Microsoft.SqlServer.Management.Smo. . :: . .NamedSmoObject
        Microsoft.SqlServer.Management.Smo.Agent. . :: . .AgentObjectBase
          Microsoft.SqlServer.Management.Smo.Agent..::..JobStep

命名空间： Microsoft.SqlServer.Management.Smo.Agent
程序集： Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
用法
Dim instance As JobStep

[SfcElementTypeAttribute("Step")]
public sealed class JobStep : AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[SfcElementTypeAttribute(L"Step")]
public ref class JobStep sealed : public AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Step")>]
type JobStep =  
    class
        inherit AgentObjectBase
        interface IAlterable
        interface ICreatable
        interface IDroppable
        interface IRenamable
        interface IScriptable
    end

public final class JobStep extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

JobStep 类型公开以下成员。

构造函数

	名称	说明
	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.

页首

属性

	名称	说明
	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. （从 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. （从 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. （从 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. （从 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. （从 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. （从 SqlSmoObject 继承。）
	Server	Gets or sets the name of the server on which the job step runs.
	State	Gets the state of the referenced object. （从 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. （从 SqlSmoObject 继承。）
	UserData	Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）

页首

方法

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

页首

事件

	名称	说明
	PropertyChanged	（从 SqlSmoObject 继承。）
	PropertyMetadataChanged	（从 SqlSmoObject 继承。）

页首

字段

	名称	说明
	m_ExtendedProperties	（从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObjectDiscover	（从 SqlSmoObject 继承。）
	IAlienObjectGetParent	（从 SqlSmoObject 继承。）
	IAlienObjectGetProperty	（从 SqlSmoObject 继承。）
	ISfcPropertyProviderGetPropertySet	（从 SqlSmoObject 继承。）
	IAlienObjectGetUrn	（从 SqlSmoObject 继承。）
	IAlienObjectResolve	（从 SqlSmoObject 继承。）
	IAlienObjectSetProperty	（从 SqlSmoObject 继承。）

页首

注释

SQL Server Agent jobs contain one or more execution units called steps. Each job step contains a textual command, type of execution that specifies command interpretation, and logic that determines the behavior of the job if the step succeeds or fails. For example, a job step can contain:

The command text. For example:

DBCC CHECKDB ('Northwind') WITH NO_INFOMSGS

A job step execution type: Transact-SQL for example.
An indication that the job should stop if the step fails.

With the JobStep object, you can do the following:

Create a SQL Server Agent job step.
Remove a job step from a SQL Server Agent job.
Manage existing job steps by changing, for example, the command text or the actions taken on success or failure of the step.
Obtain details about the last attempted execution of the step.

To get JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role.

To set JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the owner of the job step, or be a member of the sysadmin fixed server role.

To create a job step, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role. The user must also have permission on any proxy accounts used by the job step.

To drop a job step, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the job step, or be a member of the sysadmin fixed server role.

Thread Safety

此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。不保证所有实例成员都对于线程安全的。

示例

在 SQL Server 代理中计划自动管理任务

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared）成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo.Agent 命名空间

其他资源

在 SQL Server 代理中计划自动管理任务

自动执行管理任务（SQL Server 代理）

sp_help_jobstep (Transact-SQL)

通过

JobStep 类

继承层次结构

语法

构造函数

属性

方法

事件

字段

显式接口实现

注释

Thread Safety

示例

线程安全

请参阅

参考

其他资源

其他资源