IVsBackForwardNavigation::IsEqual Method (IVsWindowFrame^, String^, Object^, Int32)

Visual Studio 2015
 

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

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

C#
C++
F#
VB
Copy 
int IsEqual(
	IVsWindowFrame^ pFrame,
	String^ bstrData,
	Object^ punk,
	[OutAttribute] int% fReplaceSelf
)

Parameters

pFrame
Type: Microsoft.VisualStudio.Shell.Interop::IVsWindowFrame^

[in] Pointer to the IVsWindowFrame interface.

bstrData
Type: System::String^

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

punk
Type: System::Object^

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

fReplaceSelf
Type: System::Int32

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

Return Value

Type: System::Int32

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

From vsshell.idl:

C++
Copy 
HRESULT IVsBackForwardNavigation::IsEqual(
   [in] IVsWindowFrame *pFrame, 
   [in] BSTR bstrData, 
   [in] IUnknown *punk, 
   [out, retval] BOOL *fReplaceSelf
);
Return to top
Show: