HrComposeEID
The HrComposeEID
function creates a compound entry identifier for an object, usually a message
in a message store.
Note This function
may not be supported in future versions of MAPI.
Quick Info
Header
file: |
MAPIUTIL.H |
Implemented
by: |
MAPI |
Called by: |
Client
applications |
HrComposeEID(
LPMAPISESSION psession,
|
|
ULONG cbStoreRecordKey, |
|
LPBYTE pStoreRecordKey, |
|
ULONG cbMsgEID,
|
|
LPENTRYID pMsgEID,
|
|
ULONG FAR * pcbEID,
|
|
LPENTRYID FAR * ppEID |
|
); |
|
Parameters
psession
[in] Pointer
to the session in use by the client application.
cbStoreRecordKey
[in] Size, in
bytes, of the record key of the message store holding the message or other
object. If zero is passed in the cbStoreRecordKey parameter, the ppEID
parameter points to a copy of the object s
entry identifier.
pStoreRecordKey
[in] Pointer
to the record key of the message store containing the message or other object.
cbMsgEID
[in] Size, in
bytes, of the entry identifier of the message or other object.
pMsgEID
[in] Pointer
to the entry identifier of the object.
pcbEID
[out] Pointer
to the size, in bytes, of the returned identifier.
ppEID
[out] Pointer
to the returned data. If the value of the cbStoreRecordKey parameter is
greater than zero, the ppEID parameter points to a pointer to the
compound entry identifier that is created. If cbStoreRecordKey is zero, ppEID
points to a pointer to a copy of the object s
entry identifier.
Remarks
If the
message or other object for which the compound entry identifier is being
created resides in a message store, the identifier is created from the object s entry identifier and the store s record key. If the object is not in a store (that
is, if the byte count for the store record key passed in cbStoreRecordKey
is zero), the object s entry identifier is simply copied.
The
HrComposeEID function, primarily for use
with CMC, enables CMC-based applications to work with objects in multiple
stores through the use of compound entry identifiers.
See Also
HrComposeMsgID, HrDecomposeEID