TargetServerCollection Class
The TargetServerCollection class represents a collection of TargetServer objects that represent all the target servers defined on SQL Server Agent.
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.TargetServerCollection
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public NotInheritable Class TargetServerCollection _
Inherits SimpleObjectCollectionBase
'Usage
Dim instance As TargetServerCollection
public sealed class TargetServerCollection : SimpleObjectCollectionBase
public ref class TargetServerCollection sealed : public SimpleObjectCollectionBase
[<SealedAttribute>]
type TargetServerCollection =
class
inherit SimpleObjectCollectionBase
end
public final class TargetServerCollection extends SimpleObjectCollectionBase
The TargetServerCollection 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 TargetServer object in the collection by index number. |
|
Item[String] | Gets a TargetServer object in the collection by name. |
|
Parent | Gets the JobServer object that is the parent of the TargetServerCollection 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 a TargetServer to the collection. |
.gif "Protected method") |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) |
|
Contains | Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.) |
|
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 TargetServerCollection 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.) |
|
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 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.
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.