IVssBackupComponents::GetWriterComponentsCount method (vsbackup.h)

  • Article

The GetWriterComponentsCount method returns the number of writers whose components have been added to a requester's Backup Components Document.

Syntax

HRESULT GetWriterComponentsCount(
  [out] UINT *pcComponents
);

Parameters

[out] pcComponents

Pointer to the returned number of writers whose components have been stored.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully returned the number of components.
E_INVALIDARG
 One of the parameter values is not valid.
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_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 count returned by GetWriterComponentsCount is that of writers that have had at least one of their components stored in the Backup Components Document by earlier calls to IVssBackupComponents::AddComponent.

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

See also

IVssBackupComponents