Share via


IVsNavInfo.EnumCanonicalNodes(IVsEnumNavInfoNodes) Method

Definition

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

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