RegisteredServerCollection Class
The RegisteredServerCollection class represents a collection of RegisteredServer objects that represent all the registered servers that are defined on the parent object.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollection<RegisteredServer, RegisteredServer.Key, ServerGroup>
Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollatedDictionaryCollection<RegisteredServer, RegisteredServer.Key, ServerGroup>
Microsoft.SqlServer.Management.RegisteredServers.RegisteredServerCollection
Namespace: Microsoft.SqlServer.Management.RegisteredServers
Assembly: Microsoft.SqlServer.Management.RegisteredServers (in Microsoft.SqlServer.Management.RegisteredServers.dll)
Syntax
'Declaration
Public NotInheritable Class RegisteredServerCollection _
Inherits SfcCollatedDictionaryCollection(Of RegisteredServer, RegisteredServer.Key, ServerGroup)
'Usage
Dim instance As RegisteredServerCollection
public sealed class RegisteredServerCollection : SfcCollatedDictionaryCollection<RegisteredServer, RegisteredServer.Key, ServerGroup>
public ref class RegisteredServerCollection sealed : public SfcCollatedDictionaryCollection<RegisteredServer^, RegisteredServer.Key^, ServerGroup^>
[<SealedAttribute>]
type RegisteredServerCollection =
class
inherit SfcCollatedDictionaryCollection<RegisteredServer, RegisteredServer.Key, ServerGroup>
end
public final class RegisteredServerCollection extends SfcCollatedDictionaryCollection<RegisteredServer, RegisteredServer.Key, ServerGroup>
The RegisteredServerCollection type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
RegisteredServerCollection | Initializes a new instance of the RegisteredServerCollection class based on the specified parent object and the specified comparison interface. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Ascending | Gets or sets a value indicating whether to sort in ascending order. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
|
Count | Gets the number of elements contained in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
.gif "Protected property") |
Initialized | Gets a value indicating whether the collection has been initialized. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
IsReadOnly | Gets a value indicating whether the collection is read-only. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
|
IsSynchronized | Gets or sets a value indicating whether access to the collection is synchronized (thread safe). Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Item[String] | Gets a RegisteredServer object in the collection by name. |
|
Item[K] | Gets the item specified by the key. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Parent | Gets or sets the type of the parent object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
SyncRoot | Gets or sets an object that can be used to synchronize access to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Add | Adds the specified object to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Clear | Removes all items from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
|
Contains(String) | Determines whether the specified registered server exists in the referenced collection. |
|
Contains(T) | Determines whether the collection contains the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
|
CopyTo(array<T[], Int32) | Copies the elements from the collection to the specified array, starting at the specified array index. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
|
CopyTo(Array, Int32) | Copies the elements from the collection to the specified array, starting at the specified array index. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Equals | (Inherited from Object.) |
|
GetEnumerator | Returns an enumerator that can iterate through the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
Refresh() | Refreshes the collection by creating new and merging existing objects and properties in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Refresh(Boolean) | Refreshes the collection by creating new and merging existing objects and properties in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Remove | Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
.gif "Protected method") |
RemoveInternal | Marks the specified object for removal. The state of the object is set to ToBeDropped. The object will be removed when the parent is altered or dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
Rename | Renames the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ToString | (Inherited from Object.) |
|
TryGetValue | Gets the value associated with the specified key. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IComparer<K>.Compare | Do not reference this member directly in your code. It supports the SQL Server infrastructure. Compares two keys. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.) |
.gif "Private property") |
IListSource.ContainsListCollection | Gets a value indicating whether the collection is a collection of IList objects. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
IEnumerable.GetEnumerator | Gets an enumerator that can iterate the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
IListSource.GetList | Returns an IList object that can be bound to a data source from an object that does not implement the IList interface. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.Add | Adds the specified object to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.AddShadow | Adds the specified object to the shadow collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.Count | Gets the number of items contained in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.EnsureInitialized | Initializes the collection from the server. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.FinishMerge | Swaps the new collection for the old collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.GetCollectionElementNameImpl | Gets the URN suffix for elements in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.GetElementFactory | Gets the factory that is used to instantiate objects for the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.GetExisting | Uses the specified key to retrieve an existing item from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.GetObjectByKey | Uses the specified key to retrieve an object from the collection. If a matching object is not found, the object is created, and added to the collection (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.Initialized | Gets or sets a value indicating whether the collection has been initialized. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.Parent | Gets the parent object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.PrepareMerge | Prepares to merge fresh query results into the existing collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.Remove | Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.RemoveElement | Removes the specified element from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
|
ISfcCollection.Rename | Renames the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.) |
Top
Remarks
A RegisteredServerCollection object can be used to gain access to a set of check constraints. You can use the Item property to return a specific RegisteredServer object.
This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.
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.