BackupDeviceList Class

The BackupDeviceList object provides programmatic access to a list backup devices.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  System.Collections.Generic.List<BackupDeviceItem>
    Microsoft.SqlServer.Management.Smo.BackupDeviceList

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class BackupDeviceList _
    Inherits List(Of BackupDeviceItem)
'Usage
Dim instance As BackupDeviceList
[CLSCompliantAttribute(false)]
public class BackupDeviceList : List<BackupDeviceItem>
[CLSCompliantAttribute(false)]
public ref class BackupDeviceList : public List<BackupDeviceItem^>
[<CLSCompliantAttribute(false)>]
type BackupDeviceList =  
    class 
        inherit List<BackupDeviceItem>
    end
public class BackupDeviceList extends List<BackupDeviceItem>

The BackupDeviceList type exposes the following members.

Constructors

  Name Description
Public method BackupDeviceList() Initializes a new instance of the BackupDeviceList class.
Public method BackupDeviceList(Int32) Initializes a new instance of the BackupDeviceList class with the specified capacity.
Public method BackupDeviceList(IEnumerable<BackupDeviceItem>) Initializes a new instance of the BackupDeviceList class based on the specified BackupDeviceItem object.

Top

Properties

  Name Description
Public property Capacity (Inherited from List<BackupDeviceItem>.)
Public property Count (Inherited from List<BackupDeviceItem>.)
Public property Item (Inherited from List<BackupDeviceItem>.)

Top

Methods

  Name Description
Public method Add (Inherited from List<BackupDeviceItem>.)
Public method AddDevice Adds device type with the specified name to the list.
Public method AddRange (Inherited from List<BackupDeviceItem>.)
Public method AsReadOnly (Inherited from List<BackupDeviceItem>.)
Public method BinarySearch(T) (Inherited from List<BackupDeviceItem>.)
Public method BinarySearch(T, IComparer<T>) (Inherited from List<BackupDeviceItem>.)
Public method BinarySearch(Int32, Int32, T, IComparer<T>) (Inherited from List<BackupDeviceItem>.)
Public method Clear (Inherited from List<BackupDeviceItem>.)
Public method Contains (Inherited from List<BackupDeviceItem>.)
Public method ConvertAll<TOutput> (Inherited from List<BackupDeviceItem>.)
Public method CopyTo(array<T[]) (Inherited from List<BackupDeviceItem>.)
Public method CopyTo(array<T[], Int32) (Inherited from List<BackupDeviceItem>.)
Public method CopyTo(Int32, array<T[], Int32, Int32) (Inherited from List<BackupDeviceItem>.)
Public method Equals (Inherited from Object.)
Public method Exists (Inherited from List<BackupDeviceItem>.)
Protected method Finalize (Inherited from Object.)
Public method Find (Inherited from List<BackupDeviceItem>.)
Public method FindAll (Inherited from List<BackupDeviceItem>.)
Public method FindIndex(Predicate<T>) (Inherited from List<BackupDeviceItem>.)
Public method FindIndex(Int32, Predicate<T>) (Inherited from List<BackupDeviceItem>.)
Public method FindIndex(Int32, Int32, Predicate<T>) (Inherited from List<BackupDeviceItem>.)
Public method FindLast (Inherited from List<BackupDeviceItem>.)
Public method FindLastIndex(Predicate<T>) (Inherited from List<BackupDeviceItem>.)
Public method FindLastIndex(Int32, Predicate<T>) (Inherited from List<BackupDeviceItem>.)
Public method FindLastIndex(Int32, Int32, Predicate<T>) (Inherited from List<BackupDeviceItem>.)
Public method ForEach (Inherited from List<BackupDeviceItem>.)
Public method GetEnumerator (Inherited from List<BackupDeviceItem>.)
Public method GetHashCode (Inherited from Object.)
Public method GetRange (Inherited from List<BackupDeviceItem>.)
Public method GetType (Inherited from Object.)
Public method IndexOf(T) (Inherited from List<BackupDeviceItem>.)
Public method IndexOf(T, Int32) (Inherited from List<BackupDeviceItem>.)
Public method IndexOf(T, Int32, Int32) (Inherited from List<BackupDeviceItem>.)
Public method Insert (Inherited from List<BackupDeviceItem>.)
Public method InsertRange (Inherited from List<BackupDeviceItem>.)
Public method LastIndexOf(T) (Inherited from List<BackupDeviceItem>.)
Public method LastIndexOf(T, Int32) (Inherited from List<BackupDeviceItem>.)
Public method LastIndexOf(T, Int32, Int32) (Inherited from List<BackupDeviceItem>.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove (Inherited from List<BackupDeviceItem>.)
Public method RemoveAll (Inherited from List<BackupDeviceItem>.)
Public method RemoveAt (Inherited from List<BackupDeviceItem>.)
Public method RemoveRange (Inherited from List<BackupDeviceItem>.)
Public method Reverse() (Inherited from List<BackupDeviceItem>.)
Public method Reverse(Int32, Int32) (Inherited from List<BackupDeviceItem>.)
Public method Sort() (Inherited from List<BackupDeviceItem>.)
Public method Sort(IComparer<T>) (Inherited from List<BackupDeviceItem>.)
Public method Sort(Comparison<T>) (Inherited from List<BackupDeviceItem>.)
Public method Sort(Int32, Int32, IComparer<T>) (Inherited from List<BackupDeviceItem>.)
Public method ToArray (Inherited from List<BackupDeviceItem>.)
Public method ToString (Inherited from Object.)
Public method TrimExcess (Inherited from List<BackupDeviceItem>.)
Public method TrueForAll (Inherited from List<BackupDeviceItem>.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IList.Add (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method IList.Contains (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method ICollection.CopyTo (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method IEnumerable<T>.GetEnumerator (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method IList.IndexOf (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method IList.Insert (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate property IList.IsFixedSize (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate property ICollection<T>.IsReadOnly (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate property IList.IsReadOnly (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate property IList.Item (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate method IList.Remove (Inherited from List<BackupDeviceItem>.)
Explicit interface implemetationPrivate property ICollection.SyncRoot (Inherited from List<BackupDeviceItem>.)

Top

Remarks

With the BackupDeviceList object, you can do the following:

  • Perform a backup to the specified list of devices.

  • Add backup devices to the list.

Examples

Backing Up and Restoring Databases and Transaction Logs

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 Namespace

Other Resources

BACKUP (Transact-SQL)