IABLogon::CompareEntryIDs

The IABLogon::CompareEntryIDs method compares two entry identifiers to determine if they refer to the same object.

Quick Info

See IABLogon : IUnknown.

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

Parameters

cbEntryID1

[in] Count of bytes in the entry identifier pointed to by the lpEntryID1 parameter.

lpEntryID1

[in] Pointer to the first entry identifier to be compared.

cbEntryID2

[in] Count of bytes in the entry identifier pointed to by the lpEntryID2 parameter.

lpEntryID2

[in] Pointer to the second entry identifier to be compared.

ulFlags

Reserved; must be zero.

lpulResult

[out] Pointer to the returned result of the comparison. The contents of lpulResult is TRUE if the two entry identifiers refer to the same object, and FALSE otherwise.

Return Values

S_OK

The entry identifiers were successfully compared.

MAPI_E_INVALID_ENTRYID

One or both of the entry identifiers do not belong to the address book provider.

Remarks

Address book providers implement the IABLogon::CompareEntryIDs method to compare two entry identifiers to determine whether they refer to the same object.

CompareEntryIDs is useful because an object can have more than one valid entry identifier; such a situation can occur, for example, when trying to compare a short-term entry identifier with a long-term entry identifier.

For more information about creating entry identifiers, see Entry Identifiers.