IVsNavInfo::EnumCanonicalNodes Method (IVsEnumNavInfoNodes^)

Visual Studio 2015

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

C++

int EnumCanonicalNodes(
	[OutAttribute] IVsEnumNavInfoNodes^% ppEnum
)

Parameters

ppEnum: Type: Microsoft.VisualStudio.Shell.Interop::IVsEnumNavInfoNodes^
[out] The IVsEnumNavInfoNodes. Identifies the collection of nodes in the canonical path of the symbol.

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:

C++

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.