Export (0) Print
Expand All

IVssExamineWriterMetadata::GetComponent method

The GetComponent method obtains a Writer Metadata Document for a specified backup component.

Syntax


HRESULT GetComponent(
  [in]   UINT iComponent,
  [out]  IVssWMComponent **ppComponent
);

Parameters

iComponent [in]

Index for a component. The value of this parameter is an integer from 0 to n–1 inclusive, where n is the total number of components supported by a given writer. The value of n is returned by IVssExamineWriterMetadata::GetFileCounts.

ppComponent [out]

Doubly indirect pointer to a IVssWMComponent object containing the component information.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK

Successfully returned a pointer to an IVssWMComponent interface.

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 component does not exist.

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 caller is responsible for calling IUnknown::Release to release the resources of the returned IVssWMComponent object.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

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

Library

VssApi.lib

See also

IVssWMComponent
IVssExamineWriterMetadata
IVssExamineWriterMetadata::GetFileCounts

 

 

Community Additions

ADD
Show:
© 2014 Microsoft