IVssComponent::GetComponentType method (vswriter.h)

The GetComponentType method returns the type of this component in terms of the VSS_COMPONENT_TYPE enumeration.

Either a writer or a requester can call this method.

Syntax

HRESULT GetComponentType(
  [out] VSS_COMPONENT_TYPE *pct
);

Parameters

[out] pct

The address of a caller-allocated variable that receives a VSS_COMPONENT_TYPE enumeration value that specifies the type of the component.

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

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

VSS_COMPONENT_TYPE