IVsNavInfo.EnumCanonicalNodes Method

Defines a collection of nodes contained in the canonical path of the symbol.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function EnumCanonicalNodes ( _
    <OutAttribute> ByRef ppEnum As IVsEnumNavInfoNodes _
) As Integer
int EnumCanonicalNodes(
    out IVsEnumNavInfoNodes ppEnum
)
int EnumCanonicalNodes(
    [OutAttribute] IVsEnumNavInfoNodes^% ppEnum
)
abstract EnumCanonicalNodes : 
        ppEnum:IVsEnumNavInfoNodes byref -> int 
function EnumCanonicalNodes(
    ppEnum : IVsEnumNavInfoNodes
) : int

Parameters

Return Value

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsNavInfo::EnumCanonicalNodes(
   [out] IVsEnumNavInfoNodes ** ppEnum
);

A canonical path is a unique, fully qualified path identifying the symbol within the hierarchical tree of symbols. The canonical path starts with the top-level node and ends with a specific symbol.

.NET Framework Security

See Also

Reference

IVsNavInfo Interface

Microsoft.VisualStudio.Shell.Interop Namespace