Export (0) Print
Expand All

IVssComponent::GetComponentName method

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 *pwszName
);

Parameters

pwszName [out]

Pointer to a string containing the logical name of the component.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK

Successfully returned the attribute value.

S_FALSE

This component has no name. This state should never occur.

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.

 

Remarks

The caller should free the memory held by the pwszName parameter by calling SysFreeString.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

See also

IVssComponent

 

 

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft