Edit

Share via


IVssComponent::GetAlternateLocationMappingCount method (vswriter.h)

The GetAlternateLocationMappingCount method returns the number of alternate ___location mappings used by a requester in restoring data. Either a writer or a requester can call this method.

Syntax

HRESULT GetAlternateLocationMappingCount(
  [out] UINT *pcMappings
);

Parameters

[out] pcMappings

The address of a caller-allocated variable that receives the number of alternate ___location mappings.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
Successfully returned the attribute value.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.

Remarks

The count of alternate ___location mappings returned by GetAlternateLocationMappingCount may be due to not only files in the current component but to files in any of its nonselectable subcomponents.

An alternate ___location mapping is used only during a restore operation and should not be confused with an alternate path, which is used only during a backup operation.

The count returned by GetAlternateLocationMappingCount refers to the number of alternate ___location mappings used in the course of restoring files.

The count is updated by calls to IVssBackupComponents::AddAlternativeLocationMapping.

Requirements

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

See also

IVssComponent

IVssComponent::GetAlternateLocationMapping