PidTagEntryId Canonical Property

Office 2013 and later

Last modified: July 23, 2011

Applies to: Outlook

Contains a MAPI entry identifier used to open and edit properties of a particular MAPI object.

Associated properties:

PR_ENTRYID

Identifier:

0x0FFF

Data type:

PT_BINARY

Area:

ID properties

This property identifies an object for OpenEntry to instantiate and provides access to all of its properties through the appropriate derived interface of IMAPIProp.

This property is one of the base address properties for all messaging users.

This property can contain either a long-term or a short-term identifier. Short-term identifiers are easier and faster to construct, but are limited in their scope and duration, typically to the current session and workstation. They are commonly used for objects of a temporary nature, such as table rows or dialog box entries, and then abandoned. Long-term identifiers are used for objects of a more wide-ranging and long-lasting nature.

This property is always available through the IMAPIProp::GetProps method following the first call to the IMAPIProp::SaveChanges method. Some service providers can make it available immediately after instantiation. The provider must always return a long-term entry identifier from GetProps. Therefore, to convert a short-term identifier to long-term, simply open the object and get its this property through GetProps.

The following table summarizes important differences among this property, PR_RECORD_KEY (PidTagRecordKey), and PR_SEARCH_KEY (PidTagSearchKey).

Characteristic

PR_ENTRYID

PR_RECORD_KEY

PR_SEARCH_KEY

Required on attachment objects

No

Yes

No

Required on folder objects

Yes

Yes

No

Required on message store objects

Yes

Yes

No

Required on status objects

Yes

No

No

Created by client

No

No

Yes

Available before call to SaveChanges

Depends on provider implementation

Depends on provider implementation

For messages, Yes. For others, depends on provider implementation.

Changed in a copy operation

Yes

Yes

No

Changeable by client after a copy

No

No

Yes

Unique within

Entire world

Provider instance

Entire world

Binary comparable (as with memcmp)

No use IMAPISupport:: CompareEntryIDs

Yes

Yes

Protocol Specifications

[MS-OXPROPS]

Provides references to related Exchange Server protocol specifications.

[MS-OXCMSG]

Handles message and attachment objects.

[MS-OXOABK]

Specifies the properties and operations for lists of users, contacts, groups, and resources.

[MS-OXCMAIL]

Converts from Internet standard e-mail conventions to message objects.

[MS-OXCFXICS]

Handles the order and flow for data transfers between a client and server.

[MS-OXCPERM]

Handles the retrieval of folder permission lists that are stored on the server.

[MS-OXODLGT]

Specifies methods for connecting to and configuring mailboxes as delegates, and interactions with message and calendar objects when they act on behalf of another user.

[MS-OXWAVLS]

Specifies the schema and methods that are used to request availability information for users and resources.

Header Files

Mapidefs.h

Provides data type definitions.

Mapitags.h

Contains definitions of properties listed as alternate names.

Show: