IVsUIShell.GetCurrentBFNavigationItem(IVsWindowFrame, String, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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.

Applies to

Compartilhar via