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 (in Microsoft.VisualStudio.Shell.dll)

Syntax

'宣言
Protected Overridable Function GetCanonicalName ( _
    itemId As UInteger, _
    <OutAttribute> ByRef name As String _
) As Integer
'使用
Dim itemId As UInteger
Dim name As String
Dim returnValue As Integer

returnValue = Me.GetCanonicalName(itemId, _
    name)

protected virtual int GetCanonicalName(
    uint itemId,
    out string name
)

protected:
virtual int GetCanonicalName(
    unsigned int itemId, 
    [OutAttribute] String^% name
)

protected function GetCanonicalName(
    itemId : uint, 
    name : String
) : int

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.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 [M:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.GetCanonicalName(uint itemid, out string pbstrName)] 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.

Permissions

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.