DatabaseEngineInstanceCollection Class

 

The DatabaseEngineInstanceCollection class represents a collection of DatabaseEngineInstance objects that represent all the database instance constraints defined on the parent object.

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

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.DatabaseEngineInstanceCollection

Syntax

[DefaultMemberAttribute("Item")]
public sealed class DatabaseEngineInstanceCollection : SimpleObjectCollectionBase
[DefaultMemberAttribute("Item")]
public ref class DatabaseEngineInstanceCollection sealed : SimpleObjectCollectionBase
[<Sealed>]
[<DefaultMemberAttribute("Item")>]
type DatabaseEngineInstanceCollection = 
    class
        inherit SimpleObjectCollectionBase
    end
<DefaultMemberAttribute("Item")>
Public NotInheritable Class DatabaseEngineInstanceCollection
    Inherits SimpleObjectCollectionBase

Properties

Name Description
System_CAPS_pubproperty Count

Gets the number of objects in the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubproperty IsSynchronized

Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe.(Inherited from SmoCollectionBase.)

System_CAPS_pubproperty Item[Int32]

Gets a DatabaseEngineInstance object in the collection by index number.

System_CAPS_pubproperty Item[String]

Gets a DatabaseEngineInstance object in the collection by name.

System_CAPS_pubproperty Parent

Gets the SqlSmoObject object that is the parent of the DatabaseEngineInstanceCollection object.

System_CAPS_pubproperty SyncRoot

Gets an object that can be used to synchronize access to the collection.(Inherited from SmoCollectionBase.)

Methods

Name Description
System_CAPS_pubmethod Add(DatabaseEngineInstance)

Adds a DatabaseEngineInstance object to the DatabaseEngineInstanceCollection collection.

System_CAPS_protmethod AddExisting(SqlSmoObject)

Adds an object to the collection.(Inherited from AbstractCollectionBase.)

System_CAPS_pubmethod Contains(String)

Verifies whether the specified object exists in the collection.(Inherited from SimpleObjectCollectionBase.)

System_CAPS_pubmethod CopyTo(DatabaseEngineInstance[], Int32)

Copies the collection of objects to a one-dimensional array beginning at the index value specified.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetEnumerator()

Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ItemById(Int32)

Extracts a member from the DatabaseEngineInstanceCollection collection using a system-defined unique identifier.

System_CAPS_pubmethod Refresh()

Refreshes the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubmethod Refresh(Boolean)

Refreshes the referenced collection with the option to refresh child objects of the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Fields

Name Description
System_CAPS_protfield initialized

This value supports the SMO infrastructure and is not intended to be used directly from your code.(Inherited from AbstractCollectionBase.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod ICollection.CopyTo(Array, Int32)

Copies the elements from an instance to an array beginning at the index indicated.(Inherited from SmoCollectionBase.)

Remarks

A DatabaseEngineInstanceCollection object can be used to gain access to a set of database instance constraints. You can use the Item property to return a specific DatabaseEngineInstance 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.

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

Microsoft.SqlServer.Management.Smo Namespace

Return to top