Export (0) Print
Expand All

IVssComponent::SetPreRestoreFailureMsg method

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

wszPreRestoreFailureMsg [in]

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.

ValueMeaning
S_OK

Successfully set the failure message.

E_INVALIDARG

One of the parameter values is not valid.

E_OUTOFMEMORY

The caller is out of memory or other system resources.

VSS_E_BAD_STATE

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

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::GetPostRestoreFailureMsg
IVssComponent::GetPreRestoreFailureMsg

 

 

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft