Export (0) Print
Expand All

IVsUIShell.GetCurrentBFNavigationItem Method

Returns the current backward and forward navigation item.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int GetCurrentBFNavigationItem (
	out IVsWindowFrame ppWindowFrame,
	out string pbstrData,
	out Object ppunk
)
int GetCurrentBFNavigationItem (
	/** @attribute OutAttribute() */ /** @ref */ IVsWindowFrame ppWindowFrame, 
	/** @attribute OutAttribute() */ /** @ref */ String pbstrData, 
	/** @attribute OutAttribute() */ /** @ref */ Object ppunk
)
JScript does not support passing value-type arguments by reference.

Parameters

ppWindowFrame

[out] Pointer to the window frame for the window containing the backward and forward navigation item.

pbstrData

[out] Any arbitrary data that is needed for the navigation point (insertion point).

ppunk

[out] Pointer to a specific interface for the navigation point. This is the interface passed in AddNewBFNavigationItem.

Return Value

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

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.

Community Additions

ADD
Show:
© 2014 Microsoft