FlavoredProject.GetCanonicalName Method
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.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Protected Overridable Function GetCanonicalName ( _
itemId As UInteger, _
<OutAttribute> ByRef name As String _
) As Integer
protected virtual int GetCanonicalName(
uint itemId,
out string name
)
protected:
virtual int GetCanonicalName(
unsigned int itemId,
[OutAttribute] String^% name
)
abstract GetCanonicalName :
itemId:uint32 *
name:string byref -> int
override GetCanonicalName :
itemId:uint32 *
name:string byref -> int
protected function GetCanonicalName(
itemId : uint,
name : String
) : int
Parameters
itemId
Type: UInt32The ID of the hierarchy item.
name
Type: String%[out] The canonical name of the hierarchy item.
Return Value
Type: Int32
If the method succeeds, it returns [F: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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.