FlavoredProject.IVsHierarchy.GetCanonicalName(UInt32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Flavor

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a unique name for an item in the hierarchy. Used for workspace persistence, such as remembering window positions.

 virtual int Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.GetCanonicalName(System::UInt32 itemId, [Runtime::InteropServices::Out] System::String ^ % name) = Microsoft::VisualStudio::Shell::Interop::IVsHierarchy::GetCanonicalName;

int Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.GetCanonicalName(unsigned int itemId, [Runtime::InteropServices::Out] std::wstring const & & name);

int IVsHierarchy.GetCanonicalName (uint itemId, out string name);

abstract member Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.GetCanonicalName : uint32 * string -> int
override this.Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.GetCanonicalName : uint32 * string -> int

Function GetCanonicalName (itemId As UInteger, ByRef name As String) As Integer Implements IVsHierarchy.GetCanonicalName

Parameters

itemId: UInt32

The ID of the hierarchy item.

name: String

[out] The canonical name of the item.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

GetCanonicalName(UInt32, String)

Remarks

This method calls the GetCanonicalName method, which calls the GetCanonicalName method on the inner project.

Applies to