HierarchyNode.GetCanonicalName Method (UInt32, String%)

Gets the canonical name for the node that is specified by the item ID.

Namespace: Microsoft.VisualStudio.Package
Assembly: MPF.Project.NonShipping (in MPF.Project.NonShipping.dll)

Syntax

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

returnValue = instance.GetCanonicalName(itemId, _
    name)

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

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

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

Parameters

itemId
Type: System.UInt32

Item identifier of an item in the hierarchy.

name
Type: System.String%

[out]The canonical name (typically the fully-qualified path), if found.

Return Value

Type: System.Int32

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

Implements

IVsUIHierarchy.GetCanonicalName(UInt32, String%)
IVsHierarchy.GetCanonicalName(UInt32, String%)

Remarks

The canonical name is used for persisting properties related to this item.

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.