IMoniker::IsEqual
A version of this page is also available for
4/8/2010
This method compares one moniker with another moniker.
Syntax
HRESULT IsEqual(
IMoniker* pmkOtherMoniker
);
Parameters
- pmkOtherMoniker
[in] Pointer to the IMoniker interface on the moniker to be used for comparison with this one (the one from which this method is called).
Return Value
The following table shows the return values for this method.
Value | Description |
---|---|
S_OK |
The two monikers are identical. |
S_FALSE |
The two monikers are not identical. |
Remarks
Previous implementations of the Running Object Table (ROT) called this method. The current implementation of the ROT uses the IROTData interface instead.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Notes to Callers
Call this method to determine if two monikers are identical or not. Note that the reduced form of a moniker is considered different from the unreduced form.
You should call the IMoniker::Reduce method before calling IMoniker::IsEqual, because a reduced moniker is in its most specific form.
IMoniker::IsEqual may return S_FALSE on two monikers before they are reduced, and S_OK after they are reduced.
Notes to Implementers
Your implementation should not reduce the current moniker before performing the comparison. It is the caller's responsibility to call IMoniker::Reduce in order to compare reduced monikers.
Note that two monikers that compare as equal must hash to the same value using the IMoniker::Hash method.
Requirements
Header | objidl.h, objidl.idl |
Library | ole32.lib, uuid.lib |
Windows Embedded CE | Windows CE 2.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |