BackupDeviceCollection BackupDeviceCollection BackupDeviceCollection Class

Definition

The BackupDeviceCollection class represents a collection of BackupDevice objects that represent all the backup devices on an instance of SQL Server.

public ref class BackupDeviceCollection sealed : Microsoft::SqlServer::Management::Smo::SimpleObjectCollectionBase
public sealed class BackupDeviceCollection : Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
Public NotInheritable Class BackupDeviceCollection
Inherits SimpleObjectCollectionBase
Inheritance

Remarks

A BackupDeviceCollection object can be used to gain access to a set of backup devices. You can use the Item[String] property to return a specific BackupDevice object.

Properties

Count Count Count

Gets the number of objects in the referenced collection.

(Inherited from SmoCollectionBase)
IsSynchronized IsSynchronized IsSynchronized

Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe.

(Inherited from SmoCollectionBase)
Item[Int32] Item[Int32] Item[Int32]

Gets a BackupDevice object in the collection by index number.

Item[String] Item[String] Item[String]

Gets a BackupDevice object in the collection by name.

Parent Parent Parent

Gets the Server object that is the parent of the BackupDeviceCollection object.

SyncRoot SyncRoot SyncRoot

Gets an object that can be used to synchronize access to the collection.

(Inherited from SmoCollectionBase)

Methods

Add(BackupDevice) Add(BackupDevice) Add(BackupDevice)

Adds the specified backup device to the referenced collection.

AddExisting(SqlSmoObject) AddExisting(SqlSmoObject) AddExisting(SqlSmoObject)

Adds an object to the collection.

(Inherited from AbstractCollectionBase)
AddImpl(SqlSmoObject) AddImpl(SqlSmoObject) AddImpl(SqlSmoObject)

Adds the specified object to this collection

(Inherited from SortedListCollectionBase)
Contains(String) Contains(String) Contains(String)

Verifies whether the specified object exists in the collection.

(Inherited from SimpleObjectCollectionBase)
CopyTo(BackupDevice[], Int32) CopyTo(BackupDevice[], Int32) CopyTo(BackupDevice[], Int32)

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

GetCollectionElementType() GetCollectionElementType() GetCollectionElementType()

Gets the Collection Element Type.

(Inherited from SmoCollectionBase)
GetEnumerator() GetEnumerator() GetEnumerator()

Returns an IEnumerator interface that allows you to iterate through the objects in the collection.

(Inherited from SmoCollectionBase)
GetItemById(Int32) GetItemById(Int32) GetItemById(Int32)

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

(Inherited from SmoCollectionBase)
GetItemById(Int32, String) GetItemById(Int32, String) GetItemById(Int32, String)

Extracts a member from the referenced collection using a system-defined, unique identifier and name.

(Inherited from SmoCollectionBase)
GetObjectByIndex(Int32) GetObjectByIndex(Int32) GetObjectByIndex(Int32)

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

(Inherited from SmoCollectionBase)
ImplAddExisting(SqlSmoObject) ImplAddExisting(SqlSmoObject) ImplAddExisting(SqlSmoObject)

Adds an existing specified object to this collection

(Inherited from SortedListCollectionBase)
InitializeChildCollection() InitializeChildCollection() InitializeChildCollection()

Initializes the child collections of the referenced collection.

(Inherited from SmoCollectionBase)
InitializeChildCollection(Boolean) InitializeChildCollection(Boolean) InitializeChildCollection(Boolean)

Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection.

(Inherited from SmoCollectionBase)
InitInnerCollection() InitInnerCollection() InitInnerCollection()

Initializes the collection.

(Inherited from SimpleObjectCollectionBase)
Refresh() Refresh() Refresh()

Refreshes the referenced collection.

(Inherited from SmoCollectionBase)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Refreshes the referenced collection with the option to refresh child objects of the referenced collection.

(Inherited from SmoCollectionBase)
ValidateParentObject(SqlSmoObject) ValidateParentObject(SqlSmoObject) ValidateParentObject(SqlSmoObject)

Validates the parent object exists.

(Inherited from SmoCollectionBase)

Fields

initialized initialized initialized

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

(Inherited from AbstractCollectionBase)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

Copies the elements from an instance to an array beginning at the index indicated.

(Inherited from SmoCollectionBase)

Applies to