• Article

Backup.FormatMedia Property

Gets or sets a Boolean property value that determines whether a tape is formatted as the first step of the backup operation.

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

Syntax

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

value = instance.FormatMedia

instance.FormatMedia = value

public bool FormatMedia { get; set; }

public:
property bool FormatMedia {
    bool get ();
    void set (bool value);
}

member FormatMedia : bool with get, set

function get FormatMedia () : boolean
function set FormatMedia (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether the tape will be formatted.
If True, the Microsoft SQL Server backup operation attempts to format the tape as the initial step.
If False (default), the SQL Server backup operation does not attempt to format the tape.

Remarks

The FormatMedia property applies only when the backup medium is tape. The property has no meaning for device, file, or pipe media.