UID

title

description

helpviewer_keywords

old-location

tech.root

ms.assetid

ms.date

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

req.redist

ms.custom

f1_keywords

dev_langs

topic_type

api_type

api_location

api_name

NF:vsbackup.IVssBackupComponents.PrepareForBackup

IVssBackupComponents::PrepareForBackup (vsbackup.h)

The PrepareForBackup method will cause VSS to generate a PrepareForBackup event, signaling writers to prepare for an upcoming backup operation. This makes a requester's Backup Components Document available to writers.

IVssBackupComponents interface [VSS]

PrepareForBackup method

IVssBackupComponents.PrepareForBackup

IVssBackupComponents::PrepareForBackup

PrepareForBackup

PrepareForBackup method [VSS]

IVssBackupComponents interface

_win32_ivssbackupcomponents_prepareforbackup

base.ivssbackupcomponents_prepareforbackup

vsbackup/IVssBackupComponents::PrepareForBackup

base\ivssbackupcomponents_prepareforbackup.htm

base

46ce8282-a434-4b0b-b66e-40810052b34b

12/05/2018

IVssBackupComponents interface [VSS],PrepareForBackup method, IVssBackupComponents.PrepareForBackup, IVssBackupComponents::PrepareForBackup, PrepareForBackup, PrepareForBackup method [VSS], PrepareForBackup method [VSS],IVssBackupComponents interface, _win32_ivssbackupcomponents_prepareforbackup, base.ivssbackupcomponents_prepareforbackup, vsbackup/IVssBackupComponents::PrepareForBackup

vsbackup.h

VsBackup.h, Vss.h, VsWriter.h

Windows

Windows XP [desktop apps only]

Windows Server 2003 [desktop apps only]

VssApi.lib

Windows

19H1

IVssBackupComponents::PrepareForBackup

vsbackup/IVssBackupComponents::PrepareForBackup

c++

APIRef

kbSyntax

COM

VssApi.lib

VssApi.dll

IVssBackupComponents.PrepareForBackup

IVssBackupComponents::PrepareForBackup

-description

The PrepareForBackup method will cause VSS to generate a PrepareForBackup event, signaling writers to prepare for an upcoming backup operation. This makes a requester's Backup Components Document available to writers.

-parameters

-param ppAsync [out]

Doubly indirect pointer to an instance of the IVssAsync interface that is used to determine when the asynchronous operation is complete.

-returns

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned a pointer to an instance of the IVssAsync interface. See IVssAsync::QueryStatus for the error codes returned in the pHrResult parameter.
E_INVALIDARG	ppAsync does not point to a valid pointer; that is, it is NULL.
E_OUTOFMEMORY	The caller is out of memory or other system resources.
VSS_E_BAD_STATE	The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.
VSS_E_UNEXPECTED	Unexpected error. The error code is logged in the error log file. For more information, see Event and Error Handling Under VSS. Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead.

-remarks

PrepareForBackup generates a PrepareForBackup event, which is handled by each instance of each writer through the CVssWriter::OnPrepareBackup method.

Before PrepareForBackup can be called, IVssBackupComponents::SetBackupState must be called.

The Backup Components Document can still be modified by writers in their PrepareForBackup event handler (CVssWriter::OnPrepareBackup), and afterward until the generation of a BackupComplete event.