Compartilhar via


IVsUIShell.GetCurrentBFNavigationItem(IVsWindowFrame, String, Object) Method

Definition

Returns the current backward and forward navigation item.

public:
 int GetCurrentBFNavigationItem([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ % ppWindowFrame, [Runtime::InteropServices::Out] System::String ^ % pbstrData, [Runtime::InteropServices::Out] System::Object ^ % ppunk);
int GetCurrentBFNavigationItem([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame const & & ppWindowFrame, [Runtime::InteropServices::Out] std::wstring const & & pbstrData, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & ppunk);
public int GetCurrentBFNavigationItem (out Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame ppWindowFrame, out string pbstrData, out object ppunk);
abstract member GetCurrentBFNavigationItem : IVsWindowFrame * string * obj -> int
Public Function GetCurrentBFNavigationItem (ByRef ppWindowFrame As IVsWindowFrame, ByRef pbstrData As String, ByRef ppunk As Object) As Integer

Parameters

ppWindowFrame
IVsWindowFrame

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

pbstrData
String

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

ppunk
Object

[out] Pointer to a specific interface for the navigation point. This is the interface passed in AddNewBFNavigationItem(IVsWindowFrame, String, Object, Int32).

Returns

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.

Applies to