FlavoredProject.IVsHierarchy.GetCanonicalName Method

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

Namespace:  Microsoft.VisualStudio.Shell.Flavor
Assemblies:   Microsoft.VisualStudio.Shell.9.0 (in Microsoft.VisualStudio.Shell.9.0.dll)
  Microsoft.VisualStudio.Shell (in Microsoft.VisualStudio.Shell.dll)
  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)

Syntax

‘선언
Private Function GetCanonicalName ( _
    itemId As UInteger, _
    <OutAttribute> ByRef name As String _
) As Integer Implements IVsHierarchy.GetCanonicalName
‘사용 방법
Dim instance As FlavoredProject
Dim itemId As UInteger
Dim name As String
Dim returnValue As Integer

returnValue = CType(instance, IVsHierarchy).GetCanonicalName(itemId, _
    name)
int IVsHierarchy.GetCanonicalName(
    uint itemId,
    out string name
)
private:
virtual int GetCanonicalName(
    unsigned int itemId, 
    [OutAttribute] String^% name
) sealed = IVsHierarchy::GetCanonicalName
private abstract GetCanonicalName : 
        itemId:uint32 * 
        name:string byref -> int 
private override GetCanonicalName : 
        itemId:uint32 * 
        name:string byref -> int 
JScript does not support explicit interface implementations.

Parameters

  • name
    Type: System.String%
    [out] The canonical name of the item.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsHierarchy.GetCanonicalName(UInt32, String%)

Remarks

This method calls the GetCanonicalName method, which calls the GetCanonicalName method on the inner project.

.NET Framework Security

See Also

Reference

FlavoredProject Class

FlavoredProject Members

Microsoft.VisualStudio.Shell.Flavor Namespace