Skip to content

Latest commit

 

History

History
168 lines (135 loc) · 5.1 KB

nf-vswriter-ivsswmdependency-getcomponentname.md

File metadata and controls

168 lines (135 loc) · 5.1 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:vswriter.IVssWMDependency.GetComponentName
IVssWMDependency::GetComponentName (vswriter.h)
The GetComponentName method retrieves the name of a component that the current component depends on in an explicit writer-component dependency.
GetComponentName
GetComponentName method [VSS]
GetComponentName method [VSS]
IVssWMDependency interface
IVssWMDependency interface [VSS]
GetComponentName method
IVssWMDependency.GetComponentName
IVssWMDependency::GetComponentName
_win32_ivsswmdependency_getcomponentname
base.ivsswmdependency_getcomponentname
vswriter/IVssWMDependency::GetComponentName
base\ivsswmdependency_getcomponentname.htm
base
b0115a42-3c74-41a0-8062-0f20123780fe
12/05/2018
GetComponentName, GetComponentName method [VSS], GetComponentName method [VSS],IVssWMDependency interface, IVssWMDependency interface [VSS],GetComponentName method, IVssWMDependency.GetComponentName, IVssWMDependency::GetComponentName, _win32_ivsswmdependency_getcomponentname, base.ivsswmdependency_getcomponentname, vswriter/IVssWMDependency::GetComponentName
vswriter.h
Vss.h, VsWriter.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
VssApi.lib
Windows
19H1
IVssWMDependency::GetComponentName
vswriter/IVssWMDependency::GetComponentName
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
IVssWMDependency.GetComponentName

IVssWMDependency::GetComponentName

-description

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

-parameters

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

-returns

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.

-see-also

IVssWMComponent::GetDependency

IVssWMDependency

IVssWMDependency::GetLogicalPath

IVssWMDependency::GetWriterId