IVssBackupComponents::GetWriterMetadataCount method (vsbackup.h)

The GetWriterMetadataCount method returns the number of writers with metadata.

Syntax

HRESULT GetWriterMetadataCount(
  UINT *pcWriters
);

Parameters

pcWriters

Number of writers with metadata.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
Successfully returned the number of writers with metadata.
E_INVALIDARG
One of the parameter values is not valid.
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_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

A requester must call the asynchronous operation IVssBackupComponents::GatherWriterMetadata and wait for it to complete prior to calling IVssBackupComponents::GetWriterMetadataCount.

The number of writers returned by GetWriterMetadataCount should always be the same as that returned by IVssBackupComponents::GetWriterStatusCount.

Requirements

   
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

See also

IVssBackupComponents

IVssBackupComponents::GatherWriterMetadata

IVssBackupComponents::GetWriterMetadata

IVssExamineWriterMetadata