IVsBackForwardNavigation.IsEqual Method

Article
2015-04-29

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)

Syntax

'Declaration
Function IsEqual ( _
    pFrame As IVsWindowFrame, _
    bstrData As String, _
    punk As Object, _
    <OutAttribute> ByRef fReplaceSelf As Integer _
) As Integer

int IsEqual(
    IVsWindowFrame pFrame,
    string bstrData,
    Object punk,
    out int fReplaceSelf
)

int IsEqual(
    [InAttribute] IVsWindowFrame^ pFrame, 
    [InAttribute] String^ bstrData, 
    [InAttribute] Object^ punk, 
    [OutAttribute] int% fReplaceSelf
)

abstract IsEqual : 
        pFrame:IVsWindowFrame * 
        bstrData:string * 
        punk:Object * 
        fReplaceSelf:int byref -> int

function IsEqual(
    pFrame : IVsWindowFrame, 
    bstrData : String, 
    punk : Object, 
    fReplaceSelf : int
) : int

Parameters

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

[in] Pointer to the IVsWindowFrame interface.

bstrData
Type: String

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

punk
Type: Object

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

fReplaceSelf
Type: Int32%

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

Return Value

Type: 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
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via