IVsSymbolicNavigationManager.QueryNavigateToSymbol Method

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)

Syntax

'Declaration
Function QueryNavigateToSymbol ( _
    pHierCodeFile As IVsHierarchy, _
    itemidCodeFile As UInteger, _
    pszRQName As String, _
    <OutAttribute> ByRef ppHierToNavigate As IVsHierarchy, _
    <OutAttribute> ByRef pitemidToNavigate As UInteger, _
    <OutAttribute> pSpanToNavigate As TextSpan(), _
    <OutAttribute> ByRef pfWouldNavigate As Integer _
) As Integer
int QueryNavigateToSymbol(
    IVsHierarchy pHierCodeFile,
    uint itemidCodeFile,
    string pszRQName,
    out IVsHierarchy ppHierToNavigate,
    out uint pitemidToNavigate,
    TextSpan[] pSpanToNavigate,
    out int pfWouldNavigate
)
int QueryNavigateToSymbol(
    [InAttribute] IVsHierarchy^ pHierCodeFile, 
    [InAttribute] unsigned int itemidCodeFile, 
    [InAttribute] String^ pszRQName, 
    [OutAttribute] IVsHierarchy^% ppHierToNavigate, 
    [OutAttribute] unsigned int% pitemidToNavigate, 
    [OutAttribute] array<TextSpan>^ pSpanToNavigate, 
    [OutAttribute] int% pfWouldNavigate
)
abstract QueryNavigateToSymbol : 
        pHierCodeFile:IVsHierarchy * 
        itemidCodeFile:uint32 * 
        pszRQName:string * 
        ppHierToNavigate:IVsHierarchy byref * 
        pitemidToNavigate:uint32 byref * 
        pSpanToNavigate:TextSpan[] byref * 
        pfWouldNavigate:int byref -> int
function QueryNavigateToSymbol(
    pHierCodeFile : IVsHierarchy, 
    itemidCodeFile : uint, 
    pszRQName : String, 
    ppHierToNavigate : IVsHierarchy, 
    pitemidToNavigate : uint, 
    pSpanToNavigate : TextSpan[], 
    pfWouldNavigate : int
) : int

Parameters

  • itemidCodeFile
    Type: UInt32

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

  • pszRQName
    Type: String

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

  • pitemidToNavigate
    Type: UInt32%

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

  • pfWouldNavigate
    Type: Int32%

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

Return Value

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

.NET Framework Security

See Also

Reference

IVsSymbolicNavigationManager Interface

Microsoft.VisualStudio.Shell.Interop Namespace