IVssComponent::GetPreRestoreFailureMsg method (vswriter.h)

The GetPreRestoreFailureMsg method retrieves the error message generated by a writer while handling the PreRestore event, if IVssComponent::SetPreRestoreFailureMsg set one.

Either a writer or a requester can call this method.

Syntax

HRESULT GetPreRestoreFailureMsg(
  [out] BSTR *pbstrPreRestoreFailureMsg
);

[out] pbstrPreRestoreFailureMsg

String containing the failure message that describes an error that occurred while processing the PreRestore event.

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned the attribute value.
S_FALSE	No PreRestore failure message was available to retrieve.
E_INVALIDARG	One of the parameter values is not valid.
E_OUTOFMEMORY	The caller is out of memory or other system resources.
VSS_E_INVALID_XML_DOCUMENT	The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.

The caller should free the memory held by the pbstrPreRestoreFailureMsg parameter by calling SysFreeString.

If SetPreRestoreFailureMsg was not used to set a PreRestore failure message, GetPreRestoreFailureMsg returns S_FALSE.

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