DatabaseReplicaStateCollection Class

Article
08/11/2014

Represents a collection of objects that represent all the database replica state defined on the parent database.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.DatabaseReplicaStateCollectionBase
          Microsoft.SqlServer.Management.Smo.DatabaseReplicaStateCollection

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

Syntax

'Declaration
Public NotInheritable Class DatabaseReplicaStateCollection _
    Inherits DatabaseReplicaStateCollectionBase
'Usage
Dim instance As DatabaseReplicaStateCollection

public sealed class DatabaseReplicaStateCollection : DatabaseReplicaStateCollectionBase

public ref class DatabaseReplicaStateCollection sealed : public DatabaseReplicaStateCollectionBase

[<SealedAttribute>]
type DatabaseReplicaStateCollection =  
    class 
        inherit DatabaseReplicaStateCollectionBase 
    end

public final class DatabaseReplicaStateCollection extends DatabaseReplicaStateCollectionBase

The DatabaseReplicaStateCollection type exposes the following members.

Properties

	Name	Description
	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 DatabaseReplicaState object in the collection by index number.
	Item[String, String]	Gets a DatabaseReplicaState object in the collection by name.
	Parent	Gets the parent object of this class.
	SyncRoot	Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

	Name	Description
	Add	Adds the specified database role to the collection.
	AddExisting	Adds an object to the collection. (Inherited from AbstractCollectionBase.)
	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 DatabaseReplicaStateCollection 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.)
	Remove(DatabaseReplicaState)	Removes the specified database role to the collection.
	Remove(String, String)	Removes a DatabaseReplicaState object in the collection by name.
	ToString	(Inherited from Object.)

Top

Fields

	Name	Description
	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
	ICollection.CopyTo	Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

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.