IVssWMDependency::GetComponentName method (vswriter.h)

  • Article

The GetComponentName method retrieves the name of a component that the current component depends on in an explicit writer-component dependency.

Syntax

HRESULT GetComponentName(
  BSTR *pbstrComponentName
);

Parameters

pbstrComponentName

The address of a caller-allocated variable that receives a NULL-terminated wide character string containing the name of the component that the current component depends on.

Return value

This method can return one of these values.

Value Meaning
S_OK
 Successfully returned the name of the component that the current component depends on.
S_FALSE
 No writer can be found that manages the component that the current component depends on.
E_INVALIDARG
 The pointer pbstrComponentName points to unallocated memory.
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_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 must free the memory used by the returned string by calling SysFreeString.

A dependency does not indicate an order of preference between the component with the documented dependencies and the components it depends on. A dependency merely indicates that the component and the components it depends on must always be backed up or restored together.

It is possible to have multiple instances of a given writer class; however, any component's logical path and name should be unique.

If there are multiple instances of a writer class, it will be necessary to use logical path and component name information to identify the instance managing the component that the current component depends on.

Requirements

Requirement Value
Minimum supported client Windows Vista [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

IVssWMComponent::GetDependency

IVssWMDependency

IVssWMDependency::GetLogicalPath

IVssWMDependency::GetWriterId