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

IVssComponent::SetRestoreMetadata method

The SetRestoreMetadata method sets writer-specific metadata for the current component.

Only a writer can call this method, and only in the context of implementing CVssWriter::OnPreRestore.

Syntax


HRESULT SetRestoreMetadata(
  [in]  LPCWSTR wszRestoreMetadata
);

Parameters

wszRestoreMetadata [in]

A caller-allocated NULL-terminated wide character string containing the restore metadata for the component.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK

Successfully set the item.

E_INVALIDARG

One of the parameter values is not valid.

E_OUTOFMEMORY

The caller is out of memory or other system resources.

VSS_E_OBJECT_ALREADY_EXISTS

Private metadata has already been written for this component.

VSS_E_BAD_STATE

The method was called outside of the context of a writer handling a PreRestore event.

 

Remarks

IVssComponent::SetRestoreMetadata sets private, writer-specific metadata, which can be used by a writer during a restore operation.

The format need not conform to any VSS metadata specification.

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::GetRestoreMetadata
IVssComponent::SetBackupMetadata

 

 

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

Community Additions

Show:
© 2014 Microsoft. All rights reserved.