Export (0) Print
Expand All

IVssComponent::SetBackupMetadata method

The SetBackupMetadata method sets backup metadata with the component.

A writer can call this method only during a backup operation.

This method cannot be called while handling a BackupComplete (CVssWriter::OnBackupComplete) or BackupShutdown (CVssWriter::OnBackupShutdown) event.

Syntax


HRESULT SetBackupMetadata(
  [in]  BSTR bstrMetadata
);

Parameters

bstrMetadata [in]

A NULL-terminated wide character string that contains the backup metadata.

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

This method was not called by a writer or, if called by a writer, it either was not called during a backup operation or was called while handling a BackupComplete or BackupShutdown event.

 

Remarks

SetBackupMetadata sets private, writer-specific metadata describing a backup 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::GetBackupMetadata
IVssComponent::SetRestoreMetadata

 

 

Community Additions

ADD
Show:
© 2014 Microsoft