JobCollection Class
The JobCollection class represents a collection of Job objects that represent all the jobs defined on the JobServer object.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
Microsoft.SqlServer.Management.Smo.SmoCollectionBase
Microsoft.SqlServer.Management.Smo.ArrayListCollectionBase
Microsoft.SqlServer.Management.Smo.Agent.JobCollection
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Class JobCollection _
Inherits ArrayListCollectionBase
'Usage
Dim instance As JobCollection
public class JobCollection : ArrayListCollectionBase
public ref class JobCollection : public ArrayListCollectionBase
type JobCollection =
class
inherit ArrayListCollectionBase
end
public class JobCollection extends ArrayListCollectionBase
The JobCollection 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 an Job object in the collection by index number. |
|
Item[String] | Gets an Job object in the collection by name. |
|
Item[String, Int32] | Gets an Job object in the collection by name and category. |
|
Parent | Gets the JobServer object that is the parent of the JobCollection 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 | Adds the specified job to the job collection. |
.gif "Protected method") |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) |
|
AddImpl | Adds an object or member to this collection at the specified index. (Inherited from ArrayListCollectionBase.) |
|
Contains(String) | Determines whether the collection contains a job with the specified name. |
|
Contains(String, Int32) | Determines whether the collection contains a job with the specified name and category ID. |
|
CopyTo | Copies the collection objects to a one-dimensional array beginning at the index value specified. |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetCollectionElementType | Gets a Type object that specifies the type of the collection. (Overrides SmoCollectionBase.GetCollectionElementType().) |
|
GetEnumerator | Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.) |
|
GetHashCode | (Inherited from Object.) |
|
GetItemById(Int32) | Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.) |
|
GetItemById(Int32, String) | Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.) |
|
GetObjectByIndex | Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.) |
|
GetType | (Inherited from Object.) |
|
ImplAddExisting | Adds an existing object to the collection. (Inherited from SmoCollectionBase.) |
|
InitializeChildCollection() | Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.) |
|
InitializeChildCollection(Boolean) | Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.) |
|
InitInnerCollection | Initializes the collection. (Overrides SmoCollectionBase.InitInnerCollection().) |
|
ItemById | Gets the Job object that is specified by the Guid ID value. |
|
MemberwiseClone | (Inherited from Object.) |
|
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.) |
|
Script() | Generates a Transact-SQL script that can be used to re-create the collection of jobs. |
|
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the collection of jobs as specified by the script options. |
|
ToString | (Inherited from Object.) |
|
ValidateParentObject | Validates the parent object exists. (Inherited from SmoCollectionBase.) |
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 JobCollection object can be used to gain access to a set of jobs. You can use the Item property to return a specific Job 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.