Skip to content

Latest commit

 

History

History
198 lines (152 loc) · 5.75 KB

nf-vsbackup-ivssbackupcomponentsex2-setauthoritativerestore.md

File metadata and controls

198 lines (152 loc) · 5.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:vsbackup.IVssBackupComponentsEx2.SetAuthoritativeRestore
IVssBackupComponentsEx2::SetAuthoritativeRestore (vsbackup.h)
Marks the restore of a component as authoritative for a replicated data store.
IVssBackupComponentsEx2 interface
SetAuthoritativeRestore method
IVssBackupComponentsEx2.SetAuthoritativeRestore
IVssBackupComponentsEx2::SetAuthoritativeRestore
SetAuthoritativeRestore
SetAuthoritativeRestore method
SetAuthoritativeRestore method
IVssBackupComponentsEx2 interface
base.ivssbackupcomponentsex2_setauthoritativerestore
vsbackup/IVssBackupComponentsEx2::SetAuthoritativeRestore
base\ivssbackupcomponentsex2_setauthoritativerestore.htm
base
3725a282-2df8-4a0a-a1bf-a73c2b259cbf
12/05/2018
IVssBackupComponentsEx2 interface,SetAuthoritativeRestore method, IVssBackupComponentsEx2.SetAuthoritativeRestore, IVssBackupComponentsEx2::SetAuthoritativeRestore, SetAuthoritativeRestore, SetAuthoritativeRestore method, SetAuthoritativeRestore method,IVssBackupComponentsEx2 interface, base.ivssbackupcomponentsex2_setauthoritativerestore, vsbackup/IVssBackupComponentsEx2::SetAuthoritativeRestore
vsbackup.h
VsBackup.h, Vss.h, VsWriter.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
VssApi.lib
Windows
19H1
IVssBackupComponentsEx2::SetAuthoritativeRestore
vsbackup/IVssBackupComponentsEx2::SetAuthoritativeRestore
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
IVssBackupComponentsEx2.SetAuthoritativeRestore

IVssBackupComponentsEx2::SetAuthoritativeRestore

-description

Marks the restore of a component as authoritative for a replicated data store.

-parameters

-param writerId [in]

The globally unique identifier (GUID) of the writer class.

-param ct [in]

The type of the component. See the VSS_COMPONENT_TYPE enumeration for the possible values.

-param wszLogicalPath [in]

A null-terminated wide character string containing the logical path of the component. For more information, see Logical Pathing of Components.

The value of the string containing the logical path used here should be the same as the string that was used when the component was added.

The logical path can be NULL.

There are no restrictions on the characters that can appear in a non-NULL logical path.

-param wszComponentName [in]

A null-terminated wide character string containing the name of the component.

The string cannot be NULL and should contain the same component name as the string that was used when the component was added to the backup set using the IVssBackupComponents::AddComponent method.

-param bAuth [in]

Set this variable to true to indicate that the restore of the component is authoritative, or false otherwise.

The default value is false.

-returns

The following are the valid return codes for this method.

Value Meaning
S_OK
The restore of the component was successfully set to authoritative or nonauthoritative.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.
VSS_E_BAD_STATE
This method was not called during a restore operation.
VSS_E_OBJECT_NOT_FOUND
The specified component was not found.
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

The SetAuthoritativeRestore method can only be called during a restore operation.

A writer indicates that it supports authoritative restore by setting the VSS_BS_AUTHORITATIVE_RESTORE flag in its backup schema mask.

For more information, see Setting VSS Restore Options.

-see-also

IVssBackupComponents::SetRestoreOptions

IVssBackupComponentsEx2

IVssComponentEx::GetAuthoritativeRestore

VSS_BACKUP_SCHEMA