IVssBackupComponents::GatherWriterMetadata method (vsbackup.h)

Article
02/22/2024

The GatherWriterMetadata method prompts each writer to send the metadata they have collected. The method will generate an Identify event to communicate with writers.

Syntax

HRESULT GatherWriterMetadata(
  [out] IVssAsync **pAsync
);

Parameters

[out] pAsync

Doubly indirect pointer to an IVssAsync object containing the writer metadata.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned a pointer to an instance of the IVssAsync interface. See IVssAsync::QueryStatus for the valid values returned by the pHrResult parameter.
E_ACCESSDENIED	The caller does not have sufficient backup privileges or is not an administrator.
E_INVALIDARG	ppAsync does not point to a valid pointer; that is, it is NULL.
E_OUTOFMEMORY	The caller is out of memory or other system resources.
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.
VSS_E_WRITER_INFRASTRUCTURE	The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.
VSS_E_UNEXPECTED	Unexpected error. The error code is logged in the error log file. For more information, see Event and Error Handling Under VSS. Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead.

Remarks

The caller is responsible for releasing the IVssAsync interface.

GatherWriterMetadata should be called only once during the lifetime of a given IVssBackupComponents object.

GatherWriterMetadata generates an Identify event, which is handled by each instance of each writer through the CVssWriter::OnIdentify method, which is used to fill the Writer Metadata Document.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h)
Library	VssApi.lib