IVsSymbolicNavigationManager.QueryNavigateToSymbol Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Retrieves the alternative navigation target for the symbol if there is one (this method does not do the actual navigation).

public:
 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);

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 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

Public 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] Hierarchy of the code-file to which the code language service would otherwise navigate.

itemidCodeFile

UInt32

[in] Item identifier of the code-file to which the code language service would otherwise navigate.

pszRQName

String

[in] RQName-syntax string that identifies the symbol that is the target of the navigation.

ppHierToNavigate

IVsHierarchy

[out] Hierarchy of the alternative navigation target (that is, for the source document that generates the code file).

pitemidToNavigate

UInt32

[out] Item identifier of alternative navigation target (that is, for the source document that generates the code file).

pSpanToNavigate

TextSpan[]

[out] Location of the symbol in the alternative navigation target. Set to (0,0,0,0) if the source is not a text document.

pfWouldNavigate

Int32

[out, retval] Returns true if the alternative navigation target is returned, otherwise false.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.