Export (0) Print
Expand All

IVssComponent::GetNewTarget method

The GetNewTarget method returns the new file restoration locations for the selected component or component set. (See Working with Selectability and Logical Paths for information on selecting components.)

Either a writer or a requester can call this method.

Syntax


HRESULT GetNewTarget(
  [in]   UINT iMapping,
  [out]  IVssWMFiledesc **ppFiledesc
);

Parameters

iMapping [in]

Index number of the new target. The value of this parameter is an integer from 0 to n–1 inclusive, where n is the total number of new targets associated with a given component. The value of n is returned by IVssComponent::GetNewTargetCount.

ppFiledesc [out]

Doubly indirect pointer to an IVssWMFiledesc object containing the new target restore location information.

Return value

The following are the valid return codes for this method.

ValueMeaning
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.

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_OBJECT_NOT_FOUND

The specified item was not found.

 

Remarks

New targets returned by GetNewTarget may be those not only of files in the current component but to files in any of its nonselectable subcomponents.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

See also

IVssComponent
IVssComponent::GetNewTargetCount

 

 

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft