FlavoredProject::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.
Assembly: Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)
protected: virtual int GetCanonicalName( unsigned int itemId, [OutAttribute] String^% name )
Parameters
- itemId
-
Type:
System::UInt32
The ID of the hierarchy item.
- name
-
Type:
System::String^
[out] The canonical name of the hierarchy item.
Return Value
Type: System::Int32If the method succeeds, it returns F:Microsoft.VisualStudio.VSConstants.S_OK. If it fails, it returns an error code.
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.
Show: