IVsSymbolicNavigationNotify::OnBeforeNavigateToSymbol Method (IVsHierarchy^, UInt32, String^, Int32)

Visual Studio 2015

Determines if there is an alternate source file to navigate to for a code symbol.

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

Syntax

C++

int OnBeforeNavigateToSymbol(
	IVsHierarchy^ pHierCodeFile,
	unsigned int itemidCodeFile,
	String^ pszRQName,
	[OutAttribute] int% pfNavigationHandled
)

Parameters

pHierCodeFile: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[in] A IVsHierarchy representing the hierarchy of the code-file that the code language service would otherwise navigate to.

itemidCodeFile: Type: System::UInt32
[in] itemid of the code-file that the code language service would otherwise navigate to

pszRQName: Type: System::String^
[in] RQName-syntax string that identifies the symbol that is the target of the navigation

pfNavigationHandled: Type: System::Int32
[out] Returns true if navigation to symbol has been handled; false if the caller should do normal navigation

Return Value

Type: System::Int32

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

Remarks

This method is called before a Goto Definition operation.

COM Signature

From vsshell90.idl:

C++

HRESULT OnBeforeNavigateToSymbol(
    [in] IVsHierarchy *pHierCodeFile,
    [in] VSITEMID itemidCodeFile,
    [in] LPCOLESTR pszRQName,
    [out, retval] BOOL *pfNavigationHandled
);