IVssComponent::SetPreRestoreFailureMsg method (vswriter.h)
The SetPreRestoreFailureMsg method is used to create a message describing a failure in processing a PreRestore event.
Only a writer can call this method, and only during a restore operation.
Syntax
HRESULT SetPreRestoreFailureMsg(
[in] LPCWSTR wszPreRestoreFailureMsg
);
Parameters
[in] wszPreRestoreFailureMsg
A caller-allocated NULL-terminated wide character string containing the failure message describing an error that occurred while processing a PreRestore event.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully set the failure message. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
The caller is not in the correct state (either backup or restore) for the operation. |
Remarks
The failure message set by SetPreRestoreFailureMsg applies to all files in the component and any nonselectable subcomponents.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vswriter.h (include Vss.h, VsWriter.h) |
| Library | VssApi.lib |
See also
IVssComponent::GetPostRestoreFailureMsg