IMSProvider::CompareStoreIDs
The IMSProvider::CompareStoreIDs
method compares two message store entry identifiers to determine if they refer
to the same store object.
Quick Info
See IMSProvider
: IUnknown.
HRESULT CompareStoreIDs(
|
ULONG cbEntryID1,
|
|
|
LPENTRYID lpEntryID1,
|
|
|
ULONG cbEntryID2,
|
|
|
LPENTRYID lpEntryID2,
|
|
|
ULONG ulFlags,
|
|
|
ULONG FAR * lpulResult |
|
|
) |
|
Parameters
cbEntryID1
[in] Size, in
bytes, of the entry identifier pointed to by the lpEntryID1 parameter.
lpEntryID1
[in] Pointer
to the first entry identifier to be compared.
cbEntryID2
[in] Size, in
bytes, of 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; this variable is TRUE if the two
entry identifiers refer to the same object, and FALSE otherwise.
Return Value
S_OK
The call
succeeded and has returned the expected value or values.
Remarks
MAPI calls
the IMSProvider::CompareStoreIDs method while processing a call to the IMAPISession::OpenMsgStore method. CompareStoreIDs
is called at this point to determine which profile section, if any, is
associated with the message store being opened. A CompareStoreIDs call
can be made when no message stores are open for a particular store provider. In
addition, MAPI also calls CompareStoreIDs while processing a store
provider call to the IMAPISupport::OpenProfileSection method.
The entry
identifiers compared by CompareStoreIDs are both for the current store
provider s dynamic-link library (DLL) and are both unwrapped store entry
identifiers. For more information on wrapping store entry identifiers, see IMAPISupport::WrapStoreEntryID.
Comparing
entry identifiers is useful because an object can have more than one valid
entry identifier; such a situation can occur, for example, after a new version
of a message store provider is installed.
See Also