Backup.SkipTapeHeader Property

Gets or sets Boolean property that determines whether the tape header is read.

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

Syntax

'Declaration
Public Property SkipTapeHeader As Boolean 
    Get 
    Set
'Usage
Dim instance As Backup 
Dim value As Boolean 

value = instance.SkipTapeHeader

instance.SkipTapeHeader = value
public bool SkipTapeHeader { get; set; }
public:
property bool SkipTapeHeader {
    bool get ();
    void set (bool value);
}
member SkipTapeHeader : bool with get, set
function get SkipTapeHeader () : boolean 
function set SkipTapeHeader (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether the tape header is read.If True, a media name recorded on the medium is not selected. The backup set is appended to the medium.If False (default), a recorded media name is selected.

Remarks

SMO implements backup media initialization using the Initializeproperty. When Initialize is True, SkipTapeHeader enables or disables logic that prevents overwrite of unexpired backup sets on a medium.

Examples

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
Dim bk As New Backup
bk.Action = BackupActionType.Database
bk.Database = "AdventureWorks2012"
bk.SkipTapeHeader = true

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup
$bk.Action = [Microsoft.SqlServer.Management.Smo.BackupActionType]::Database
$bk.Database = "AdventureWorks2012"
$bk.SkipTapeHeader = $TRUE

See Also

Reference

Backup Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

BACKUP (Transact-SQL)

Backing Up and Restoring Databases and Transaction Logs