VsSymbolicNavigationManagerClass::QueryNavigateToSymbol Method (IVsHierarchy^, UInt32, String^, IVsHierarchy^, UInt32, array<TextSpan>^, Int32)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.9.0 (in Microsoft.VisualStudio.Shell.Interop.9.0.dll)

Syntax

C++

public:
virtual int QueryNavigateToSymbol(
	IVsHierarchy^ pHierCodeFile,
	unsigned int itemidCodeFile,
	String^ pszRQName,
	[OutAttribute] IVsHierarchy^% ppHierToNavigate,
	[OutAttribute] unsigned int% pitemidToNavigate,
	array<TextSpan>^ pSpanToNavigate,
	[OutAttribute] int% pfWouldNavigate
)

Parameters

pHierCodeFile: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[in] The IVsHierarchy of the alternate code file within which to navigate.

itemidCodeFile: Type: System::UInt32
[in] The VSConstants::VSITEMID of the alternate code file within which to navigate.

pszRQName: Type: System::String^
[in] Refactor-qualified-name(RQName)-syntax string that identifies the symbol to navigate to.

ppHierToNavigate: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[out] The IVsHierarchy of the alternate navigation target (the source document that generates the code file).

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

pSpanToNavigate: Type: array<Microsoft.VisualStudio.TextManager.Interop::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: Type: System::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.

Return Value

Type: System::Int32

Returns S_OK if the method succeeds.

Implements

IVsSymbolicNavigationManager::QueryNavigateToSymbol(IVsHierarchy^, UInt32, String^, IVsHierarchy^, UInt32, array<TextSpan>^, Int32)

Remarks

This method does not actually do the navigation.