Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IVssComponent::GetPostRestoreFailureMsg method

The GetPostRestoreFailureMsg method returns the failure message generated by a writer while handling the PostRestore event, if IVssComponent::SetPostRestoreFailureMsg set one.

Either a writer or a requester can call this method.

Syntax


HRESULT GetPostRestoreFailureMsg(
  [out]  BSTR *pbstrPostRestoreFailureMsg
);

Parameters

pbstrPostRestoreFailureMsg [out]

Pointer to a string containing the failure message that describes an error that occurred while processing the PostRestore event.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK

Successfully returned the attribute value.

S_FALSE

No PostRestoreFailure 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.

 

Remarks

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

If SetPostRestoreFailureMsg was not used to set a PostRestore failure message, GetPreRestoreFailureMsg returns S_FALSE.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

See also

IVssComponent
IVssComponent::SetPostRestoreFailureMsg
IVssComponent::SetPreRestoreFailureMsg
IVssComponent::GetPreRestoreFailureMsg

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.