IVsSymbolicNavigationNotify.QueryNavigateToSymbol Method

Returns the alternate navigation target for the symbol 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
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

'Usage
Dim instance As IVsSymbolicNavigationNotify 
Dim pHierCodeFile As IVsHierarchy 
Dim itemidCodeFile As UInteger 
Dim pszRQName As String 
Dim ppHierToNavigate As IVsHierarchy 
Dim pitemidToNavigate As UInteger 
Dim pSpanToNavigate As TextSpan()
Dim pfWouldNavigate As Integer 
Dim returnValue As Integer 

returnValue = instance.QueryNavigateToSymbol(pHierCodeFile, _
    itemidCodeFile, pszRQName, ppHierToNavigate, _
    pitemidToNavigate, pSpanToNavigate, _
    pfWouldNavigate)

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
)

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] 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

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

[out] A IVsHierarchy representing the hierarchy of alternate navigation target that is, for the source document that generates the code file).

pitemidToNavigate
Type: System.UInt32%

[out] itemid for the hierarchy of alternate navigation.

pSpanToNavigate
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]

[out] A TextSpan representing the location of symbol in alternate navigation target. Set to (0,0,0,0) if the source is not a Text document.

pfWouldNavigate
Type: System.Int32%

[out] Returns true if alternate navigation target is returned; otherwise returns false.

Return Value

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

Remarks

This method returns an alternate navigation target if one exists, but does not actually do the navigation.

COM Signature

From vsshell90.idl:

HRESULT QueryNavigateToSymbol(
    [in] IVsHierarchy *pHierCodeFile,
    [in] VSITEMID itemidCodeFile,
    [in] LPCOLESTR pszRQName,
    [out] IVsHierarchy **ppHierToNavigate,
    [out] VSITEMID *pitemidToNavigate,
    [out] TextSpan *pSpanToNavigate,
    [out, retval] BOOL *pfWouldNavigate
);

.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.