FormatMedia Property

SQL-DMO

SQL-DMO

FormatMedia Property

The FormatMedia property controls tape formatting on a backup operation.

Applies To
Backup Object
Syntax

object.FormatMedia [= value]

Part

object

Expression that evaluates to an object in the Applies To list

value

TRUE or FALSE

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFormatMedia(LPBOOL pRetVal);

HRESULT SetFormatMedia(BOOL NewValue);

Remarks

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

If TRUE, the Microsoft® SQL Server™ backup operation attempts to format the tape as an initial step.

If FALSE, the SQL Server backup operation does not attempt to format the tape.