Share via

Backup.RetainDays Property

  • Article

Gets or sets the number of days that must elapse before a backup set can be overwritten.

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

Syntax

'Declaration
Public Property RetainDays As Integer

public int RetainDays { get; set; }

public:
property int RetainDays {
    int get ();
    void set (int value);
}

/** @property */
public int get_RetainDays ()

/** @property */
public void set_RetainDays (int value)

public function get RetainDays () : int

public function set RetainDays (value : int)

Property Value

An Int32 value that specifies the retention period in days. By default, the value is set to zero.

Remarks

Backup set retention period is set when media is initialized. When using SQL Server Management Objects (SMO) to automate Microsoft SQL Server backup, the RetainDays property is only evaluated when the Initialize property is True.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Back Up Databases and Transaction Logs in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Backup Class
Backup Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Backing Up and Restoring Databases in SQL Server
BACKUP (Transact-SQL)