IABLogon::CompareEntryIDs

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Compares two entry identifiers to determine whether they refer to the same object.

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

Parameters

  • cbEntryID1
    [in] The byte count in the entry identifier pointed to by the lpEntryID1 parameter.

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

  • cbEntryID2
    [in] The byte count in 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.

  • lpulRet
    [out] A pointer to the result of the comparison. TRUE to indicate that the two entry identifiers refer to the same object; otherwise, FALSE.

Return Value

  • 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 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 you compare a short-term entry identifier with a long-term entry identifier.

For more information about how to create entry identifiers, see MAPI Entry Identifiers.

See Also

Reference

IABLogon : IUnknown