PR_SEARCH_KEY
The
PR_SEARCH_KEY property contains a binary-comparable key that identifies
correlated objects for a search.
Quick Info
Header
file: |
MAPITAGS.H |
Must be
exposed by: |
Address
book container, distribution list, messaging user, and message objects |
Identifier: |
0x300B |
Property
type: |
PT_BINARY |
Property
tag: |
0x300B0102 |
Corresponding
X.400 attribute: |
IM_THIS_IPM |
Remarks
The PR_SEARCH_KEY
property provides a trace for related objects, such as message copies, and
facilitates finding unwanted occurrences, such as duplicate recipients.
PR_SEARCH_KEY
is one of the base address properties for all messaging users. For more information
on the base address properties, see Base Address Properties
MAPI uses
specific rules for constructing search keys for message recipients. The search
key is formed by concatenating the address type (in uppercase characters), the
colon character : , the e-mail address in canonical form, and the terminating
null character. Canonical form here means that case-sensitive addresses appear
in the correct case, and addresses that are not case-sensitive are converted to
uppercase. This is important in preserving correlations among messages.
For message
objects, PR_SEARCH_KEY is available through the IMAPIProp::GetProps
For profiles,
MAPI also furnishes a hard-coded profile section named MUID_PROFILE_INSTANCE,
with PR_SEARCH_KEY as its single property. This key is guaranteed to be unique
among all profiles ever created, and can be more reliable than the PR_PROFILE_NAME
The following
table summarizes important differences among the PR_ENTRYID
Characteristic |
PR_ENTRYID |
PR_RECORD_KEY |
PR_SEARCH_KEY |
Required on
|
No |
Yes |
No |
Required on
|
Yes |
Yes |
No |
Required on
|
Yes |
Yes |
No |
Required on
|
Yes |
No |
No |
Creatable
by client |
No |
No |
Yes |
Available
before |
Maybe |
Maybe |
Messages Yes |
Changed in
a |
Yes |
Yes |
NO |
Changeable
by client |
No |
No |
Yes |
Unique
within ... |
Entire
world |
Provider
instance |
Entire
world |
Binary
comparable |
No -- use |
Yes |
Yes |
See Also