Share via


FlavoredProject.GetCanonicalName(UInt32, String) Method

Definition

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

protected:
 virtual int GetCanonicalName(System::UInt32 itemId, [Runtime::InteropServices::Out] System::String ^ % name);
 virtual int GetCanonicalName(unsigned int itemId, [Runtime::InteropServices::Out] std::wstring const & & name);
protected virtual int GetCanonicalName (uint itemId, out string name);
abstract member GetCanonicalName : uint32 * string -> int
override this.GetCanonicalName : uint32 * string -> int
Protected Overridable Function GetCanonicalName (itemId As UInteger, ByRef name As String) As Integer

Parameters

itemId
UInt32

The ID of the hierarchy item.

name
String

[out] The canonical name of the hierarchy item.

Returns

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

Remarks

This method calls GetCanonicalName on the inner project.

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