ServerGroupCollection Class

Note: This API is now obsolete.

The ServerGroupCollection class represents a collection of ServerGroup objects that represent all the server groups on the server group.

Inheritance Hierarchy

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

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 ServerGroupCollection _
    Inherits RegSvrCollectionBase _
    Implements ICollection, IEnumerable
'Usage
Dim instance As ServerGroupCollection

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

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

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

public final class ServerGroupCollection extends RegSvrCollectionBase implements ICollection, IEnumerable

The ServerGroupCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of objects in the referenced 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 ServerGroup object in the collection by index number.
	Item[String]	Gets a ServerGroup object in the collection by name.
	Parent	Gets the ServerGroup object that is the parent of the ServerGroupCollection 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 ServerGroup object to the ServerGroupCollection collection.
	Contains	Determines whether the specified string value exists within the collection.
	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 lets you iterate through the objects in the collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Remove	Removes a ServerGroup object from the ServerGroupCollection 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 ServerGroupCollection object can be used to gain access to a set of server groups. You can use the Item property to return a specific ServerGroup object.

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

Other Resources

Using Collections