共用方式為


JobStep 類別

The JobStep class represents a Microsoft SQL Server job step.

命名空間:  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 取得或設定 Boolean 屬性值,指定物件是否設定為執行純量選項。 (繼承自 SqlSmoObject。)
公用屬性 ID Gets or sets the ID value that uniquely identifies the job step.
受保護的屬性 IsTouched 取得 Boolean 屬性值,指定物件屬性是否已更新但尚未保存在伺服器上。 (繼承自 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 that 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 取得 Boolean 屬性值,指定物件是否存在於隔離中,或是直接或間接連接至 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 取得代表物件屬性的 Property 物件集合。 (繼承自 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 取得受參考物件的純量結果。 (繼承自 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 取得可唯一識別物件的統一資源名稱 (URN) 位址值。 (繼承自 SqlSmoObject。)
公用屬性 UserData Gets or sets user-defined data associated with the referenced object. (繼承自 SmoObjectBase。)

上層

方法

  名稱 說明
受保護的方法 AddDatabaseContext(StringCollection) 將資料庫內容加入至以 queries 參數來識別的查詢集合。 (繼承自 SqlSmoObject。)
受保護的方法 AddDatabaseContext(StringCollection, ScriptingOptions) 將資料庫內容加入至以 queries 參數來識別的查詢集合,並使用指定的指令碼選項。 (繼承自 SqlSmoObject。)
公用方法 Alter Updates any JobStep object property changes on instance of Microsoft SQL Server. 
受保護的方法 AlterImpl 啟動物件更改事件。 (繼承自 SqlSmoObject。)
受保護的方法 AlterImplFinish 物件更改事件完成時呼叫的方法。 (繼承自 SqlSmoObject。)
受保護的方法 AlterImplInit 初始化物件更改事件時呼叫的方法。 (繼承自 SqlSmoObject。)
受保護的方法 AlterImplWorker 呼叫 Alter 方法。 (繼承自 SqlSmoObject。)
受保護的方法 BindDefaultImpl 繫結參數所識別的預設項目。 (繼承自 SqlSmoObject。)
受保護的方法 BindRuleImpl 將規則結構描述繫結至參數所識別的規則和資料行。 (繼承自 SqlSmoObject。)
受保護的方法 CheckCollation 檢查 collationName 參數所識別之定序方法的指令碼選項順序。 (繼承自 SqlSmoObject。)
受保護的方法 CheckObjectState() () () () 驗證受參考物件的狀態。 (繼承自 SqlSmoObject。)
受保護的方法 CheckObjectState(Boolean) 驗證受參考物件的狀態,並以選項指定如果還未建立該物件則擲回例外狀況。 (繼承自 SqlSmoObject。)
受保護的方法 CheckObjectStateImpl 檢查 SqlSmoObject 的狀態。 (繼承自 SqlSmoObject。)
受保護的方法 CheckVersion100 檢查 SQL Server 的版本是否為 SQL Server 2008。 (繼承自 SqlSmoObject。)
受保護的方法 CheckVersion80 檢查 SQL Server 2000 上物件的有效性。 (繼承自 SqlSmoObject。)
受保護的方法 CheckVersion80SP3 檢查 SQL Server 2000 SP3 上物件的有效性。 (繼承自 SqlSmoObject。)
受保護的方法 CheckVersion90 檢查 SQL Server 2005 上物件的有效性。 (繼承自 SqlSmoObject。)
受保護的方法 CheckVersionBelow90 檢查 SQL Server 的版本是否在 SQL Server 2005 之前。 (繼承自 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) Deletes job step log files that have log numbers lower than the specified value.
公用方法 Discover 探索 Object 類型的清單。 (繼承自 SqlSmoObject。)
公用方法 Drop Removes the referenced job step.
受保護的方法 DropImpl 卸除 SqlSmoObject。 (繼承自 SqlSmoObject。)
受保護的方法 DropImplWorker 呼叫 Drop 方法。 (繼承自 SqlSmoObject。)
公用方法 EnumLogs Returns an enumerated list of the job step log files.
受保護的方法 EnumScriptImpl 列舉 so 參數所指定的指令碼。 (繼承自 SqlSmoObject。)
受保護的方法 EnumScriptImplWorker 呼叫方法,用以列舉 so 參數所指定的指令碼。 (繼承自 SqlSmoObject。)
受保護的方法 EnumScriptImplWorkerSOChanged 傳回 IEnumerable 字串,描述物件的指令碼選項。 (繼承自 SqlSmoObject。)
公用方法 Equals (繼承自 Object。)
受保護的方法 ExecuteNonQuery (繼承自 SqlSmoObject。)
受保護的方法 Finalize (繼承自 Object。)
受保護的方法 FormatSqlVariant 將物件格式化為 SqlVariant 類型。 (繼承自 SqlSmoObject。)
受保護的方法 GenerateDataSpaceFileStreamScript 產生指令碼來建立資料檔案。 (繼承自 SqlSmoObject。)
受保護的方法 GenerateDataSpaceScript 產生指令碼來配置資料檔中的空間。 (繼承自 SqlSmoObject。)
受保護的方法 GetBindDefaultScript 取得指令碼,用以繫結由 defSchema 和 defName 參數所指定的預設值。 (繼承自 SqlSmoObject。)
受保護的方法 GetBindRuleScript 取得指令碼,用以指定繫結規則。 (繼承自 SqlSmoObject。)
受保護的方法 GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) 指派 SqlSmoObject 的布林參數。 (繼承自 SqlSmoObject。)
受保護的方法 GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) 指派 SqlSmoObject 的布林屬性。 (繼承自 SqlSmoObject。)
受保護的方法 GetDateTimeParameter 指派 SqlSmoObject 的日期時間屬性。 (繼承自 SqlSmoObject。)
受保護的方法 GetDateTimeParameterAsInt 如果 SqlSmoObject 的日期時間屬性不是 null,則將該日期時間屬性指派為整數值。 (繼承自 SqlSmoObject。)
受保護的方法 GetDBName 不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 Gets the database name that is associated with the object. (繼承自 AgentObjectBase。)
受保護的方法 GetEnumParameter 指派 SqlSmoObject 的列舉屬性。 (繼承自 SqlSmoObject。)
受保護的方法 GetFragOptionString 取得以字串值表示的 FragmentationOption 物件。 (繼承自 SqlSmoObject。)
受保護的方法 GetGuidParameter 指派 SqlSmoObjectGuid 屬性。 (繼承自 SqlSmoObject。)
公用方法 GetHashCode (繼承自 Object。)
受保護的方法 GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) 指派 SqlSmoObject 的參數。 (繼承自 SqlSmoObject。)
受保護的方法 GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) 指派 SqlSmoObject 的參數。 (繼承自 SqlSmoObject。)
受保護的方法 GetPropValue 取得 SqlSmoObject 物件的屬性值。 (繼承自 SqlSmoObject。)
受保護的方法 GetPropValueOptional 取得 SqlSmoObject 物件的屬性值。 (繼承自 SqlSmoObject。)
受保護的方法 GetPropValueOptionalAllowNull 取得 SqlSmoObject 物件的屬性值。 (繼承自 SqlSmoObject。)
受保護的方法 GetRealValue 取得 SqlSmoObject 物件的屬性值。 (繼承自 SqlSmoObject。)
受保護的方法 GetScriptingOptionsForCreate 取得 SqlSmoObject 物件的 ScriptingOptions。 (繼承自 SqlSmoObject。)
受保護的方法 GetServerName 取得物件相關聯之 SQL Server 執行個體的名稱。 (繼承自 SqlSmoObject。)
受保護的方法 GetServerObject 取得 SqlSmoObject 物件的伺服器。 (繼承自 SqlSmoObject。)
受保護的方法 GetSqlServerVersionName 取得物件相關聯之 SQL Server 執行個體的版本名稱。 (繼承自 SqlSmoObject。)
受保護的方法 GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) 指派 SqlSmoObject 物件的字串參數。 (繼承自 SqlSmoObject。)
受保護的方法 GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) 指派 SqlSmoObject 物件的字串參數。 (繼承自 SqlSmoObject。)
受保護的方法 GetTimeSpanParameterAsInt 指派 SqlSmoObject 物件的時間範圍參數。 (繼承自 SqlSmoObject。)
公用方法 GetType (繼承自 Object。)
受保護的方法 GetUrnRecursive(StringBuilder) 指派 SqlSmoObject 物件的 Urn 物件。 (繼承自 SqlSmoObject。)
受保護的方法 GetUrnRecursive(StringBuilder, UrnIdOption) 指派 SqlSmoObject 物件的 Urn 物件。 (繼承自 SqlSmoObject。)
受保護的方法 ImplInitialize 初始化 SqlSmoObject 物件的欄位。 (繼承自 SqlSmoObject。)
公用方法 Initialize() () () () 初始化物件,並強制載入屬性。 (繼承自 SqlSmoObject。)
公用方法 Initialize(Boolean) 初始化物件,並強制載入屬性。 (繼承自 SqlSmoObject。)
受保護的方法 IsObjectDirty 驗證物件屬性是否已經過修改,而變更尚未保存在 SQL Server 的執行個體上。 (繼承自 SqlSmoObject。)
受保護的方法 IsObjectInitialized 驗證物件是否已初始化。 (繼承自 SqlSmoObject。)
受保護的方法 IsObjectInSpace 驗證物件是否已隔離,或是連接至 SQL Server 的執行個體。 (繼承自 SqlSmoObject。)
受保護的方法 IsVersion80SP3 判斷 SQL Server 的版本是否為 SQL Server 2000 SP3。 (繼承自 SqlSmoObject。)
受保護的方法 IsVersion90AndAbove 判斷 SQL Server 的版本是否為 SQL Server 2005 或更新版本。 (繼承自 SqlSmoObject。)
受保護的方法 MarkDropped 設定卸除 SqlSmoState。 (繼承自 SqlSmoObject。)
受保護的方法 MarkForDropImpl 設定卸除 SqlSmoState。 (繼承自 SqlSmoObject。)
受保護的方法 MemberwiseClone (繼承自 Object。)
受保護的方法 PostAlter SqlSmoObject 更改後啟動的方法。 (繼承自 SqlSmoObject。)
受保護的方法 PostCreate SqlSmoObject 建立後啟動的方法。 (繼承自 SqlSmoObject。)
受保護的方法 PostDrop SqlSmoObject 卸除後啟動的方法。 (繼承自 SqlSmoObject。)
公用方法 Refresh 接下來要存取物件時,重新整理該物件並擷取屬性。 (繼承自 SqlSmoObject。)
公用方法 Rename Renames the job step.
受保護的方法 RenameImpl 僅供參考之用。不支援。我們無法保證未來的相容性。 (繼承自 NamedSmoObject。)
受保護的方法 RenameImplWorker 僅供參考之用。不支援。我們無法保證未來的相容性。 (繼承自 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。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (繼承自 NamedSmoObject。)
受保護的方法 ScriptCreate 根據參數來更改 SqlSmoObject。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptDdl 擲回 InvalidSmoOperationException。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptDrop 擲回 InvalidSmoOperationException。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptImpl() () () () 取得 SqlSmoObject 指令碼的集合。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptImpl(ScriptingOptions) 取得 SqlSmoObject 指令碼的集合。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptImplWorker 取得 SqlSmoObject 指令碼的集合。 (繼承自 SqlSmoObject。)
受保護的方法 ScriptOwner Alters the script owner authorization. (繼承自 NamedSmoObject。)
受保護的方法 ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (繼承自 NamedSmoObject。)
受保護的方法 SetParentImpl SqlSmoObject 的父系設定為 newParent 參數。 (繼承自 SqlSmoObject。)
受保護的方法 SetSchemaOwned Sets the schema owned value. (繼承自 NamedSmoObject。)
公用方法 ToString 傳回代表受參考物件的 String。 (繼承自 SqlSmoObject。)
受保護的方法 TouchImpl 未實作。 (繼承自 SqlSmoObject。)
受保護的方法 UnbindDefaultImpl SqlSmoObject 的預設資料行解除繫結。 (繼承自 SqlSmoObject。)
受保護的方法 UnbindRuleImpl SqlSmoObject 的規則解除繫結。 (繼承自 SqlSmoObject。)
公用方法 Validate Validates the state of an object. (繼承自 SmoObjectBase。)

上層

事件

  名稱 說明
公用事件 PropertyChanged 代表屬性變更時所發生的事件。 (繼承自 SqlSmoObject。)
公用事件 PropertyMetadataChanged 代表屬性中繼資料變更時所發生的事件。 (繼承自 SqlSmoObject。)

上層

欄位

  名稱 說明
受保護的欄位 m_ExtendedProperties 代表屬性,此屬性定義為擴充 SqlSmoObject 所提供的屬性。 (繼承自 SqlSmoObject。)
受保護的欄位 singletonParent 代表單一父代。 (繼承自 SqlSmoObject。)

上層

明確 繼承 實作

  名稱 說明
明確介面實作私用方法 IAlienObject. . :: . .Discover 探索任何相依性。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .GetDomainRoot 傳回網域的根目錄。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .GetParent 取得此物件的父系。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .GetPropertyType 取得指定的屬性類型。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .GetPropertyValue 取得指定的屬性值。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .GetUrn 取得物件的統一資源名稱。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .Resolve 取得執行個體,其中包含物件統一資源名稱之物件的相關資訊。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .SetObjectState 將物件狀態設定為指定的 SfcObjectState 值。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 IAlienObject. . :: . .SetPropertyValue 設定屬性值。 (繼承自 SqlSmoObject。)
明確介面實作私用方法 ISfcPropertyProvider. . :: . .GetPropertySet 取得此物件屬性集的介面參考。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 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 為共用) 成員具備多執行緒作業安全。不保證所有執行個體成員都是安全執行緒。 

執行緒安全性

這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。