IVssComponent::GetComponentName method (vswriter.h)
The GetComponentName method returns the logical name of this component.
Either a writer or a requester can call this method.
Syntax
HRESULT GetComponentName(
[out] BSTR *pbstrName
);
Parameters
[out] pbstrName
Pointer to a string containing the logical name of the component.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully returned the attribute value. |
|
This component has no name. This state should never occur. |
|
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. |
Remarks
The caller should free the memory held by the pwszName parameter by calling SysFreeString.
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 |