IVssWMComponent::GetComponentInfo method (vsbackup.h)
The GetComponentInfo method obtains basic information about the specified writer metadata component.
Syntax
HRESULT GetComponentInfo(
[out] PVSSCOMPONENTINFO *ppInfo
);
Parameters
[out] ppInfo
Doubly indirect pointer to a VSS_COMPONENTINFO structure containing the returned component information.
Return value
The following are the valid return codes for this method.
Value | Meaning |
---|---|
|
Successfully returned the component information. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS. |
|
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 freeing the returned VSS_COMPONENTINFO structure by calling IVssWMComponent::FreeComponentInfo.
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 |