JobStepCollection Class
The JobStepCollection class represents a collection of JobStep objects that represent all the job steps defined on the parent Job object.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
Microsoft.SqlServer.Management.Smo.SmoCollectionBase
Microsoft.SqlServer.Management.Smo.ArrayListCollectionBase
Microsoft.SqlServer.Management.Smo.ParameterCollectionBase
Microsoft.SqlServer.Management.Smo.Agent.JobStepCollection
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public NotInheritable Class JobStepCollection _
Inherits ParameterCollectionBase
'Usage
Dim instance As JobStepCollection
public sealed class JobStepCollection : ParameterCollectionBase
public ref class JobStepCollection sealed : public ParameterCollectionBase
[<SealedAttribute>]
type JobStepCollection =
class
inherit ParameterCollectionBase
end
public final class JobStepCollection extends ParameterCollectionBase
The JobStepCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Count | Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.) |
|
IsSynchronized | Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.) |
|
Item[Int32] | Gets a JobStep object in the collection by index number. |
|
Item[String] | Gets a JobStep object in the collection by name. |
|
Parent | Gets the Job object that is the parent of the JobStepCollection object. |
|
SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Add(JobStep) | Adds a JobStep object to the JobStepCollection collection. |
|
Add(JobStep, Int32) | Adds a JobStep object to the JobStepCollection collection. |
|
Add(JobStep, String) | Adds a JobStep object to the JobStepCollection collection. |
.gif "Protected method") |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) |
|
Contains | Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from ParameterCollectionBase.) |
|
CopyTo | Copies the collection objects to a one-dimensional array beginning at the index value specified. |
|
Equals | (Inherited from Object.) |
|
GetEnumerator | Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
ItemById | Extracts a member from the JobStepCollection collection using a system-defined, unique identifier. |
|
Refresh() | Refreshes the referenced collection. (Inherited from SmoCollectionBase.) |
|
Refresh(Boolean) | Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.) |
|
Remove(String) | Removes a member from the collection with the specified name. (Inherited from ParameterCollectionBase.) |
|
Remove(JobStep) | Removes a JobStep object from the JobStepCollection collection. |
|
ToString | (Inherited from Object.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
initialized | This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICollection.CopyTo | Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.) |
Top
Remarks
A JobStepCollection object can be used to gain access to a set of job steps. You can use the Item property to return a specific JobStep object.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Examples
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.