Export (0) Print
Expand All

JobCollection Class

The JobCollection class represents a collection of Job objects that represent all the jobs defined on the JobServer object.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

[DefaultMemberAttribute("Item")]
public class JobCollection : ArrayListCollectionBase

The JobCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public propertyIsSynchronizedGets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public propertyItem[Int32]Gets an Job object in the collection by index number.
Public propertyItem[String]Gets an Job object in the collection by name.
Public propertyItem[String, Int32]Gets an Job object in the collection by name and category.
Public propertyParentGets the JobServer object that is the parent of the JobCollection object.
Public propertySyncRootGets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)
Top

  NameDescription
Public methodAddAdds the specified job to the job collection.
Protected methodAddExistingAdds an object to the collection. (Inherited from AbstractCollectionBase.)
Protected methodAddImplAdds an object or member to this collection at the specified index. (Inherited from ArrayListCollectionBase.)
Public methodContains(String)Determines whether the collection contains a job with the specified name.
Public methodContains(String, Int32)Determines whether the collection contains a job with the specified name and category ID.
Public methodCopyToCopies the collection objects to a one-dimensional array beginning at the index value specified.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetCollectionElementTypeGets a Type object that specifies the type of the collection. (Overrides SmoCollectionBase.GetCollectionElementType().)
Public methodGetEnumeratorReturns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetItemById(Int32)Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
Protected methodGetItemById(Int32, String)Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.)
Protected methodGetObjectByIndexExtracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
Public methodGetType (Inherited from Object.)
Protected methodImplAddExistingAdds an existing object to the collection. (Inherited from SmoCollectionBase.)
Protected methodInitializeChildCollection()Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.)
Protected methodInitializeChildCollection(Boolean)Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.)
Protected methodInitInnerCollectionInitializes the collection. (Overrides SmoCollectionBase.InitInnerCollection().)
Public methodItemByIdGets the Job object that is specified by the Guid ID value.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRefresh()Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public methodRefresh(Boolean)Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public methodScript()Generates a Transact-SQL script that can be used to re-create the collection of jobs.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the collection of jobs as specified by the script options.
Public methodToString (Inherited from Object.)
Protected methodValidateParentObjectValidates the parent object exists. (Inherited from SmoCollectionBase.)
Top

  NameDescription
Protected fieldinitializedThis value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollectionCopyToCopies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft