IVsSymbolicNavigationNotify.OnBeforeNavigateToSymbol Method

Article
04/29/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

'Declaration
Function OnBeforeNavigateToSymbol ( _
    pHierCodeFile As IVsHierarchy, _
    itemidCodeFile As UInteger, _
    pszRQName As String, _
    <OutAttribute> ByRef pfNavigationHandled As Integer _
) As Integer

int OnBeforeNavigateToSymbol(
    IVsHierarchy pHierCodeFile,
    uint itemidCodeFile,
    string pszRQName,
    out int pfNavigationHandled
)

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

abstract OnBeforeNavigateToSymbol : 
        pHierCodeFile:IVsHierarchy * 
        itemidCodeFile:uint32 * 
        pszRQName:string * 
        pfNavigationHandled:int byref -> int

function OnBeforeNavigateToSymbol(
    pHierCodeFile : IVsHierarchy, 
    itemidCodeFile : uint, 
    pszRQName : String, 
    pfNavigationHandled : int
) : int

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

[in] itemid of the code-file that the code language service would otherwise navigate to

pszRQName
Type: String

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

pfNavigationHandled
Type: Int32%

[out] Returns true if navigation to symbol has been handled; false if the caller should do normal navigation

Return Value

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

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via