IVsUIShell.GetCurrentBFNavigationItem Method

Article
03/06/2013

Returns the current backward and forward navigation item.

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

Syntax

'Declaration
Function GetCurrentBFNavigationItem ( _
    <OutAttribute> ByRef ppWindowFrame As IVsWindowFrame, _
    <OutAttribute> ByRef pbstrData As String, _
    <OutAttribute> ByRef ppunk As Object _
) As Integer

int GetCurrentBFNavigationItem(
    out IVsWindowFrame ppWindowFrame,
    out string pbstrData,
    out Object ppunk
)

int GetCurrentBFNavigationItem(
    [OutAttribute] IVsWindowFrame^% ppWindowFrame, 
    [OutAttribute] String^% pbstrData, 
    [OutAttribute] Object^% ppunk
)

abstract GetCurrentBFNavigationItem : 
        ppWindowFrame:IVsWindowFrame byref * 
        pbstrData:string byref * 
        ppunk:Object byref -> int

function GetCurrentBFNavigationItem(
    ppWindowFrame : IVsWindowFrame, 
    pbstrData : String, 
    ppunk : Object
) : int

Parameters

ppWindowFrame
Type: Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame%
[out] Pointer to the window frame for the window containing the backward and forward navigation item.

pbstrData
Type: System.String%
[out] Any arbitrary data that is needed for the navigation point (insertion point).

ppunk
Type: System.Object%
[out] Pointer to a specific interface for the navigation point. This is the interface passed in AddNewBFNavigationItem.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShell::GetCurrentBFNavigationItem(
   [out] IVsWindowFrame **ppWindowFrame,
   [out] BSTR * pbstrData,
   [out] IUnknown **ppunk
);

If you want to provide backward and forward navigation points within your window, implement IVsBackForwardNavigation. The core text editor uses text markers to identify navigation points in the environment.

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