OperatorCollection Class

  • Article

The OperatorCollection class represents a collection of Operator objects that represent all the operators defined on the JobServer object.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
          Microsoft.SqlServer.Management.Smo.Agent.OperatorCollection

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

Syntax

'Declaration
Public NotInheritable Class OperatorCollection _
    Inherits SimpleObjectCollectionBase
'Usage
Dim instance As OperatorCollection

public sealed class OperatorCollection : SimpleObjectCollectionBase

public ref class OperatorCollection sealed : public SimpleObjectCollectionBase

[<SealedAttribute>]
type OperatorCollection =  
    class 
        inherit SimpleObjectCollectionBase 
    end

public final class OperatorCollection extends SimpleObjectCollectionBase

The OperatorCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public property IsSynchronized Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public property Item[Int32] Gets an Operator object in the collection by index number.
Public property Item[String] Gets an Operator object in the collection by name.
Public property Parent Gets the JobServer object that is the parent of the OperatorCollection object.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds an Microsoft.SqlServer.Management.Smo.Agent.Operator to the Microsoft.SqlServer.Management.Smo.Agent.OperatorCollection
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
Public method CopyTo Copies the collection objects to a one-dimensional array beginning at the index value specified.
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ItemById Extracts a member from the OperatorCollection collection using a system-defined, unique identifier.
Public method Refresh() Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public method Refresh(Boolean) Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the collection of operators.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the collection of operators as specified by the script options.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
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
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

Remarks

An OperatorCollection object can be used to gain access to a set of operators. You can use the Item property to return a specific Operator 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

Using Collections

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.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Agent Namespace