IVssExamineWriterMetadata::GetFileCounts method

The GetFileCounts method obtains excluded files and the number of components that a writer manages.

Syntax

HRESULT GetFileCounts(
  UINT *pcIncludeFiles,
  UINT *pcExcludeFiles,
  UINT *pcComponents
);

Parameters

pcIncludeFiles

Reserved for system use.

pcExcludeFiles

The address of a caller-allocated variable that receives the number of file sets that are explicitly excluded from the backup.

pcComponents

The address of a caller-allocated variable that receives the total number of components that are managed by the current writer.

Return Value

The following are the valid return codes for this method.

Value Meaning
S_OK
Successfully returned the number of files.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.
VSS_E_INVALID_XML_DOCUMENT
The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.
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.

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

IVssExamineWriterMetadata

IVssExamineWriterMetadata::GetComponent

IVssExamineWriterMetadata::GetExcludeFile