TargetServerCollection Class

TargetServerCollection Class

The TargetServerCollection class represents a collection of TargetServer objects that represent all the target servers defined on SQL Server Agent.

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

public sealed class TargetServerCollection : SimpleObjectCollectionBase

The TargetServerCollection 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 a TargetServer object in the collection by index number.
Public propertyItem[String]Gets a TargetServer object in the collection by name.
Public propertyParentGets the JobServer object that is the parent of the TargetServerCollection object.
Public propertySyncRootGets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)
Top

  NameDescription
Public methodAddAdds a TargetServer object to the TargetServerCollection collection.
Protected methodAddExistingAdds an object to the collection. (Inherited from AbstractCollectionBase.)
Protected methodAddImplAdds the specified object to this collection (Inherited from SortedListCollectionBase.)
Public methodContainsVerifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
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 the Collection Element Type. (Inherited from SmoCollectionBase.)
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 specified object to this collection (Inherited from SortedListCollectionBase.)
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. (Inherited from SimpleObjectCollectionBase.)
Public methodItemByIdExtracts a member from the TargetServerCollection collection using a system-defined, unique identifier.
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 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 methodICollection.CopyToCopies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)
Top

A TargetServerCollection object can be used to gain access to a set of target servers. You can use the Item property to return a specific TargetServer 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.

Community Additions

ADD
Show:
© 2016 Microsoft