Backup.FormatMedia Property

Article
12/03/2008

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.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Property FormatMedia As Boolean

public bool FormatMedia { get; set; }

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

/** @property */
public boolean get_FormatMedia ()

/** @property */
public void set_FormatMedia (boolean value)

public function get FormatMedia () : boolean

public function set FormatMedia (value : boolean)

Property Value

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.

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