IVssComponentEx::GetPostSnapshotFailureMsg method (vswriter.h)

Returns the PostSnapshot failure message string that a writer has set for a given component.

Both writers and requesters can call this method. Writers should call this method after the IVssBackupComponents::DoSnapshotSet asynchronous operation has completed.

Syntax

HRESULT GetPostSnapshotFailureMsg(
  BSTR *pbstrFailureMsg
);

Parameters

pbstrFailureMsg

A pointer to a null-terminated wide character string containing the failure message that describes an error that occurred while processing a PostSnapshot event.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
The failure message was successfully obtained.
S_FALSE
No PostSnapshot failure message was set for the component.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.

Remarks

The caller is responsible for freeing the string that the pbstrFailureMsg parameter points to by calling the SysFreeString function.

Requirements

   
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

See also

CVssWriter::OnPostSnapshot

IVssComponentEx

IVssComponentEx::SetPostSnapshotFailureMsg