IVssBackupComponents::FreeWriterMetadata method

The FreeWriterMetadata method frees system resources allocated when IVssBackupComponents::GatherWriterMetadata was called.

Syntax


HRESULT FreeWriterMetadata();

Parameters

This method has no parameters.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK

The writer metadata was successfully freed.

VSS_E_BAD_STATE

The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.

 

Remarks

This method should never be called prior to the completion of IVssBackupComponents::GatherWriterMetadata. The result of calling the method prior to completion of the metadata gather is undefined.

Once writer metadata has been freed, it cannot be recovered by the current instance of the IVssBackupComponents interface. It will be necessary to create a new instance of IVssBackupComponents, and call the IVssBackupComponents::GatherWriterMetadata method again.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

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

Library

VssApi.lib

See also

IVssBackupComponents
IVssBackupComponents::GatherWriterMetadata

 

 

Show: