VsSymbolicNavigationManagerClass.QueryNavigateToSymbol Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Retrieves the alternate navigation target for the specified symbol,l if there is one.

public:
 virtual int QueryNavigateToSymbol(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHierCodeFile, System::UInt32 itemidCodeFile, System::String ^ pszRQName, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ % ppHierToNavigate, [Runtime::InteropServices::Out] System::UInt32 % pitemidToNavigate, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ pSpanToNavigate, [Runtime::InteropServices::Out] int % pfWouldNavigate);

 virtual int QueryNavigateToSymbol(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & pHierCodeFile, unsigned int itemidCodeFile, std::wstring const & pszRQName, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & & ppHierToNavigate, [Runtime::InteropServices::Out] unsigned int & pitemidToNavigate, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & pSpanToNavigate, [Runtime::InteropServices::Out] int & pfWouldNavigate);

public virtual int QueryNavigateToSymbol (Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHierCodeFile, uint itemidCodeFile, string pszRQName, out Microsoft.VisualStudio.Shell.Interop.IVsHierarchy ppHierToNavigate, out uint pitemidToNavigate, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] pSpanToNavigate, out int pfWouldNavigate);

abstract member QueryNavigateToSymbol : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * string * IVsHierarchy * uint32 * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * int -> int
override this.QueryNavigateToSymbol : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * string * IVsHierarchy * uint32 * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * int -> int

Public Overridable Function QueryNavigateToSymbol (pHierCodeFile As IVsHierarchy, itemidCodeFile As UInteger, pszRQName As String, ByRef ppHierToNavigate As IVsHierarchy, ByRef pitemidToNavigate As UInteger, pSpanToNavigate As TextSpan(), ByRef pfWouldNavigate As Integer) As Integer

Parameters

pHierCodeFile

IVsHierarchy

[in] The IVsHierarchy of the alternate code file within which to navigate.

itemidCodeFile

UInt32

[in] The VSConstants.VSITEMID of the alternate code file within which to navigate.

pszRQName

String

[in] Refactor-qualified-name(RQName)-syntax string that identifies the symbol to navigate to.

ppHierToNavigate

IVsHierarchy

[out] The IVsHierarchy of the alternate navigation target (the source document that generates the code file).

pitemidToNavigate

UInt32

[out] The VSConstants.VSITEMID of the alternate navigation target (the source document that generates the code file).

pSpanToNavigate

TextSpan[]

[out] The location of the specified symbol in the alternate navigation target. Set to (0,0,0,0) if the alternate target is not a text document.

pfWouldNavigate

Int32

[out] Flag indicating whether an alternate navigation target for the specified symbol has been found. Returns true if an alternate target is returned; otherwise returns false.

Returns

Int32

Returns S_OK if the method succeeds.

Implements

QueryNavigateToSymbol(IVsHierarchy, UInt32, String, IVsHierarchy, UInt32, TextSpan[], Int32)

Remarks

This method does not actually do the navigation.