VsSymbolicNavigationManagerClass.QueryNavigateToSymbol Method

Article
07/12/2014

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

'Declaration
Public Overridable 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

public virtual int QueryNavigateToSymbol(
    IVsHierarchy pHierCodeFile,
    uint itemidCodeFile,
    string pszRQName,
    out IVsHierarchy ppHierToNavigate,
    out uint pitemidToNavigate,
    TextSpan[] pSpanToNavigate,
    out int pfWouldNavigate
)

public:
virtual 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  
override QueryNavigateToSymbol : 
        pHierCodeFile:IVsHierarchy * 
        itemidCodeFile:uint32 * 
        pszRQName:string * 
        ppHierToNavigate:IVsHierarchy byref * 
        pitemidToNavigate:uint32 byref * 
        pSpanToNavigate:TextSpan[] byref * 
        pfWouldNavigate:int byref -> int

public function QueryNavigateToSymbol(
    pHierCodeFile : IVsHierarchy, 
    itemidCodeFile : uint, 
    pszRQName : String, 
    ppHierToNavigate : IVsHierarchy, 
    pitemidToNavigate : uint, 
    pSpanToNavigate : TextSpan[], 
    pfWouldNavigate : int
) : int

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.

.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