Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 3.75 KB

nf-vswriter-cvsswriter-getrestoretype.md

File metadata and controls

104 lines (75 loc) · 3.75 KB
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:vswriter.CVssWriter.GetRestoreType
CVssWriter::GetRestoreType (vswriter.h)
The GetRestoreType method returns the type of restore a writer is participating in.
CVssWriter interface [VSS]
GetRestoreType method
CVssWriter.GetRestoreType
CVssWriter::GetRestoreType
GetRestoreType
GetRestoreType method [VSS]
GetRestoreType method [VSS]
CVssWriter interface
_win32_cvsswriter_getrestoretype
base.cvsswriter_getrestoretype
vswriter/CVssWriter::GetRestoreType
base\cvsswriter_getrestoretype.htm
base
438298ee-ab8b-4604-9d43-5acefd7cabd5
12/05/2018
CVssWriter interface [VSS],GetRestoreType method, CVssWriter.GetRestoreType, CVssWriter::GetRestoreType, GetRestoreType, GetRestoreType method [VSS], GetRestoreType method [VSS],CVssWriter interface, _win32_cvsswriter_getrestoretype, base.cvsswriter_getrestoretype, vswriter/CVssWriter::GetRestoreType
vswriter.h
Vss.h, VsWriter.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
VssApi.lib
Windows
19H1
CVssWriter::GetRestoreType
vswriter/CVssWriter::GetRestoreType
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
CVssWriter.GetRestoreType

CVssWriter::GetRestoreType

-description

The GetRestoreType method returns the type of restore a writer is participating in.

GetRestoreType is a protected method implemented by the CVssWriter base class.

-returns

This method returns the type of restore operation a writer is participating in, in terms of values of the VSS_RESTORE_TYPE enumeration.

If GetRestoreType is called during a backup operation, the return value is undefined.

-remarks

This method should be called only during restore operations.

The default restore type is VSS_RTYPE_UNDEFINED. However, writers should treat this restore type as if it were VSS_RTYPE_BY_COPY.

A requester can set the restore type by calling the IVssBackupComponents::SetRestoreState method.

A requester can call IVssBackupComponents::SetRestoreState anytime prior to its generation of a PreRestore event with the IVssBackupComponents::PreRestore method. Therefore, to obtain the correct restore type, a writer should not call GetRestoreType prior to handling the PreRestore event in CVssWriter::OnPreRestore.

-see-also

CVssWriter

CVssWriter::OnPreRestore

IVssBackupComponents::PreRestore

IVssBackupComponents::SetRestoreState

VSS_RESTORE_TYPE