Share via


FormatMedia Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The FormatMedia property controls tape formatting on a backup operation.

Syntax

object
.FormatMedia [=value]

Parts

  • object
    An 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 if 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.

Applies To:

Backup Object