IVsNavInfo.EnumCanonicalNodes(IVsEnumNavInfoNodes) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int EnumCanonicalNodes([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsEnumNavInfoNodes ^ % ppEnum);

public:
 int EnumCanonicalNodes([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsEnumNavInfoNodes ^ &  ppEnum);

int EnumCanonicalNodes([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsEnumNavInfoNodes const & & ppEnum);

public int EnumCanonicalNodes (out Microsoft.VisualStudio.Shell.Interop.IVsEnumNavInfoNodes ppEnum);

abstract member EnumCanonicalNodes : IVsEnumNavInfoNodes -> int

Public Function EnumCanonicalNodes (ByRef ppEnum As IVsEnumNavInfoNodes) As Integer

Parameters

ppEnum: IVsEnumNavInfoNodes

[out] The IVsEnumNavInfoNodes. Identifies the collection of nodes in the canonical path of the symbol.

Returns

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.

Applies to