FlavoredProject::IVsUIHierarchy::GetCanonicalName Method (UInt32, String^)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Shell.Flavor
Assembly: Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

Syntax

C++

private:
virtual int GetCanonicalName(
	unsigned int itemid,
	[OutAttribute] String^% pbstrName
) sealed = IVsUIHierarchy::GetCanonicalName

Parameters

itemid: Type: System::UInt32
The ID of the hierarchy item.

pbstrName: Type: System::String^
[out] The canonical name of the item.

Return Value

Type: System::Int32

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

Implements

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