IMSLogon::CompareEntryIDs

Applies to: Outlook 2013 | Outlook 2016

Compares two entry identifiers to determine whether they refer to the same object. MAPI refers this call to a service provider only if the unique identifiers (UIDs) in both entry identifiers to be compared are handled by that provider.

HRESULT CompareEntryIDs(
  ULONG cbEntryID1,
  LPENTRYID lpEntryID1,
  ULONG cbEntryID2,
  LPENTRYID lpEntryID2,
  ULONG ulFlags,
  ULONG FAR * lpulResult
);

Parameters

cbEntryID1

[in] The size, in bytes, of the entry identifier pointed to by the lpEntryID1 parameter .

lpEntryID1

[in] A pointer to the first entry identifier to be compared.

cbEntryID2

[in] The size, in bytes, of the entry identifier pointed to by the lpEntryID2 parameter .

lpEntryID2

[in] A pointer to the second entry identifier to be compared.

ulFlags

[in] Reserved; must be zero.

lpulResult

[out] A pointer to the returned result of the comparison. TRUE if the two entry identifiers refer to the same object; otherwise, FALSE.

Return value

S_OK

The call succeeded and has returned the expected value or values.

Remarks

Message store providers implement the IMSLogon::CompareEntryIDs method to compare two entry identifiers for a given entry in a message store to determine whether they refer to the same object. If the two entry identifiers refer to the same object, CompareEntryIDs sets the lpulResult parameter to TRUE; if they refer to different objects, CompareEntryIDs sets lpulResult to FALSE.

CompareEntryIDs is useful because an object can have more than one valid entry identifier. This can occur, for example, after a new version of a message store provider is installed.

See also

IMSLogon : IUnknown