Skip to content

Latest commit

 

History

History
128 lines (102 loc) · 3.57 KB

nf-vswriter-ivsscomponentex-getrestorename.md

File metadata and controls

128 lines (102 loc) · 3.57 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.IVssComponentEx.GetRestoreName
IVssComponentEx::GetRestoreName (vswriter.h)
Obtains the logical name assigned to a component that is being restored.
GetRestoreName
GetRestoreName method
GetRestoreName method
IVssComponentEx interface
IVssComponentEx interface
GetRestoreName method
IVssComponentEx.GetRestoreName
IVssComponentEx::GetRestoreName
base.ivsscomponentex_getrestorename
vswriter/IVssComponentEx::GetRestoreName
base\ivsscomponentex_getrestorename.htm
base
a544bcc1-6a42-4cda-824c-2b027b8a4a6f
12/05/2018
GetRestoreName, GetRestoreName method, GetRestoreName method,IVssComponentEx interface, IVssComponentEx interface,GetRestoreName method, IVssComponentEx.GetRestoreName, IVssComponentEx::GetRestoreName, base.ivsscomponentex_getrestorename, vswriter/IVssComponentEx::GetRestoreName
vswriter.h
Vss.h, VsWriter.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
VssApi.lib
Windows
19H1
IVssComponentEx::GetRestoreName
vswriter/IVssComponentEx::GetRestoreName
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
IVssComponentEx.GetRestoreName

IVssComponentEx::GetRestoreName

-description

Obtains the logical name assigned to a component that is being restored.

-parameters

-param pbstrName [out]

The address of a caller-allocated variable that receives a null-terminated wide character string containing the restore name for the component.

-returns

The following are the valid return codes for this method.

Value Meaning
S_OK
The operation was successful.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.

-remarks

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

If the call to GetRestoreName is successful, the caller is responsible for freeing the string that is returned in the pbstrName parameter by calling the SysFreeString function.

A writer indicates that it supports this method by setting the VSS_BS_RESTORE_RENAME flag in its backup schema mask.

For more information, see Setting VSS Restore Options.

-see-also

IVssBackupComponentsEx2::SetRestoreName

IVssComponentEx

VSS_BACKUP_SCHEMA