FlavoredProject.IVsUIHierarchy.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

Package:: Microsoft.VisualStudio.Shell.15.0 v17.12.40392

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 the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.

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

int Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy.GetCanonicalName(unsigned int itemid, [Runtime::InteropServices::Out] std::wstring const & & pbstrName);

int IVsUIHierarchy.GetCanonicalName (uint itemid, out string pbstrName);

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

Function GetCanonicalName (itemid As UInteger, ByRef pbstrName As String) As Integer Implements IVsUIHierarchy.GetCanonicalName

Parameters

itemid: UInt32

The ID of the hierarchy item.

pbstrName: String

[out] The canonical name of the item.

Returns

Int32

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

Implements

GetCanonicalName(UInt32, String)

Remarks

This method calls GetCanonicalName.

Canonical names do not change between sessions of the environment, but item identifiers do. Use this method to manage workspace persistence, such as remembering window positions.

Applies to

Compartir a través de