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

 

Gets a unique name for 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)

private:
virtual int GetCanonicalName(
	unsigned int itemId,
	[OutAttribute] String^% name
) sealed = IVsHierarchy::GetCanonicalName

Parameters

itemId
Type: System::UInt32

The ID of the hierarchy item.

name
Type: System::String^

[out] The canonical name of the item.

Return Value

Type: System::Int32

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

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

Return to top
Show: