IVsBackForwardNavigation.IsEqual Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Determines if the current navigation point is the current location in the document. Returns true if this is the case.

public:
 int IsEqual(Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ pFrame, System::String ^ bstrData, System::Object ^ punk, [Runtime::InteropServices::Out] int % fReplaceSelf);

int IsEqual(Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame const & pFrame, std::wstring const & bstrData, winrt::Windows::Foundation::IInspectable const & punk, [Runtime::InteropServices::Out] int & fReplaceSelf);

public int IsEqual (Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame pFrame, string bstrData, object punk, out int fReplaceSelf);

abstract member IsEqual : Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame * string * obj * int -> int

Public Function IsEqual (pFrame As IVsWindowFrame, bstrData As String, punk As Object, ByRef fReplaceSelf As Integer) As Integer

Parameters

pFrame: IVsWindowFrame

[in] Pointer to the IVsWindowFrame interface.

bstrData: String

[in] Optional. String to match to determine the identity of the current position and the navigation point.

punk: Object

[in] Pointer to the IUnknown of the object providing the interface from which to retrieve the navigation points.

fReplaceSelf: Int32

[out] Boolean indicating whether (true) or not the current navigation point needs to replace itself.

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 IVsBackForwardNavigation::IsEqual(  
   [in] IVsWindowFrame *pFrame,   
   [in] BSTR bstrData,   
   [in] IUnknown *punk,   
   [out, retval] BOOL *fReplaceSelf  
);

Applies to

Share via