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

 

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

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

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

itemidCodeFile
Type: System::UInt32

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

pszRQName
Type: System::String^

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

ppHierToNavigate
Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^

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

pitemidToNavigate
Type: System::UInt32

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

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

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

Return Value

Type: System::Int32

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

Return to top
Show: