RegisteredServerCollection Class

Note: This API is now obsolete.

The RegisteredServerCollection class represents a collection of RegisteredServer objects that represent all the registered servers on the registered server group.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.RegisteredServers.RegSvrCollectionBase
    Microsoft.SqlServer.Management.Smo.RegisteredServers.RegisteredServerCollection

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

Syntax

'Declaration
<ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")> _
Public NotInheritable Class RegisteredServerCollection _
    Inherits RegSvrCollectionBase _
    Implements ICollection, IEnumerable
'Usage
Dim instance As RegisteredServerCollection

[ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")]
public sealed class RegisteredServerCollection : RegSvrCollectionBase, 
    ICollection, IEnumerable

[ObsoleteAttribute(L"Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")]
public ref class RegisteredServerCollection sealed : public RegSvrCollectionBase, 
    ICollection, IEnumerable

[<SealedAttribute>]
[<ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")>]
type RegisteredServerCollection =  
    class 
        inherit RegSvrCollectionBase 
        interface ICollection 
        interface IEnumerable 
    end

public final class RegisteredServerCollection extends RegSvrCollectionBase implements ICollection, IEnumerable

The RegisteredServerCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of RegisteredServer objects in the collection.
	IsSynchronized	Gets a Boolean value indicating whether access to the collection is synchronized and therefore thread-safe. (Inherited from RegSvrCollectionBase.)
	Item[Int32]	Gets a RegisteredServer object in the collection by index number.
	Item[String]	Gets a RegisteredServer object in the collection by name.
	Parent	Gets the ServerGroup object that is the parent of the RegisteredServerCollection object.
	SyncRoot	Gets an object that can be used to synchronize access to the collection. (Inherited from RegSvrCollectionBase.)

Top

Methods

	Name	Description
	Add	Adds a RegisteredServer object to the RegisteredServerCollection collection.
	Contains	Determines whether the specified string value exists within the collection.
	CopyTo	Copies the collection of objects to a one-dimensional array starting at the specified index value.
	Equals	(Inherited from Object.)
	GetEnumerator	Returns an IEnumerator interface that allows you to iterate through the objects in the collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Remove	Removes a RegisteredServer object from the RegisteredServerCollection object.
	ToString	(Inherited from Object.)

Top

Fields

	Name	Description
	initialized	Gets a Boolean value indicating the collection is initialized.If True, collection is initialized. If False the collection is not initialized. (Inherited from RegSvrCollectionBase.)
	innerColl	The sort list which contains the underlying collection of registered servers. (Inherited from RegSvrCollectionBase.)

Top

Remarks

A RegisteredServerCollection object can be used to gain access to a set of registered servers. You can use the Item property to return a specific RegisteredServer object.

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.RegisteredServers Namespace

Other Resources

Using Collections