Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Obtains the logical name assigned to a component that is being restored.
Syntax
HRESULT GetRestoreName(
[out] BSTR *pbstrName
);
Parameters
[out] pbstrName
The address of a caller-allocated variable that receives a null-terminated wide character string containing the restore name for the component.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
The operation was successful. |
|
One of the parameter values is not valid. |
|
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.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | vswriter.h (include Vss.h, VsWriter.h) |
| Library | VssApi.lib |