Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IVssComponent::GetRestoreSubcomponent method

The GetRestoreSubcomponent method returns the specified subcomponent associated with a given component.

Either a writer or a requester can call this method.

Syntax


HRESULT GetRestoreSubcomponent(
  [in]   UINT iComponent,
  [out]  BSTR *pbstrLogicalPath,
  [out]  BSTR *pbstrComponentName,
  [out]  bool *pbRepair
);

Parameters

iComponent [in]

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

pbstrLogicalPath [out]

Pointer to a string containing the logical path of the subcomponent. The logical path cannot be empty when working with subcomponents.

pbstrComponentName [out]

Pointer to a string containing the name of the subcomponent. The string cannot be empty.

pbRepair [out]

Reserved for future use.

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

The caller should free the memory held by the pbstrLogicalPath and pbstrComponentName parameters by calling SysFreeString.

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

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.