PidTagDisplayTypeEx Canonical Property

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Contains the type of an entry, with respect to how the entry should be displayed in a row in a table for the Global Address List.

Associated properties:

PR_DISPLAY_TYPE_EX

Identifier:

0x3905

Data type:

PT_LONG

Area:

MAPI address book

Remarks

This property specifies the type of an entry, with respect to how it should be displayed in the Global Address List. It provides additional information that cannot be represented in PR_DISPLAY_TYPE (PidTagDisplayType).

Note

The values of both PR_DISPLAY_TYPE and this property begin with "DT_" and are defined in Mapitags.h. All values not documented are reserved for MAPI. Client applications must not define any new values and must be prepared to deal with an undocumented value.

There are some macros that can help determine attributes of an object such as whether it is local, remote, or security-controlled. These macros include:

Macro

Value

DTE_FLAG_REMOTE_VALID

0x80000000)

DTE_FLAG_ACL_CAPABLE

0x40000000

DTE_MASK_REMOTE

0x0000ff00

DTE_MASK_LOCAL

0x000000ff

DTE_IS_REMOTE_VALID(v)

(!!((v) & DTE_FLAG_REMOTE_VALID)

DTE_IS_ACL_CAPABLE(v)

(!!((v) & DTE_FLAG_ACL_CAPABLE))

DTE_REMOTE(v)

(((v) & DTE_MASK_REMOTE) >> 8)

DTE_LOCAL(v)

((v) & DTE_MASK_LOCAL)

DT_ROOM

((ULONG) 0x00000007)

DT_EQUIPMENT

((ULONG) 0x00000008)

DT_SEC_DISTLIST

((ULONG) 0x00000009)

The following are a few notes about how to use these macros.

  • To check whether an entry is a remote entry in another forest, apply the DTE_IS_REMOTE_VALID macro to the value of this property to check whether the DTE_FLAG_REMOTE_VALID flag is set in the entry. If it is a remote entry, you can then find out the type of the remote entry by using the DTE_REMOTE macro.

  • In both single-forest and cross-forest configurations, when PR_DISPLAY_TYPE has the value of DT_DISTLIST, and DTE_IS_REMOTE_VALID is false, applying the macro DTE_LOCAL to the value of this property can let you further identify the type of the object as either DT_DISTLIST (a distribution list) or DT_SEC_DISTLIST (a security distribution list).

  • If you apply the macro DTE_LOCAL to the value of PR_DISPLAY_TYPE_EX and it returns the type DT_REMOTE_MAILUSER, then the entry is a remote entry.

  • In a single forest or in a cross-forest configuration where replication is controlled by an Access Control List (ACL), you can use the DTE_IS_ACL_CAPABLE macro to determine whether an entry is a security principal.

In a cross-forest configuration, PR_DISPLAY_TYPE has the value of DT_REMOTE_MAILUSER. Applying the macro DTE_REMOTE to the value of this property can let you obtain the type of the remote entry. The possible types of remote entry are the following:

Type of Remote Entry

Value

Description

DT_AGENT

((ULONG) 0x00000003)

Dynamic distribution list.

DT_DISTLIST

((ULONG) 0x00000001)

Distribution list.

DT_EQUIPMENT

((ULONG) 0x00000008)

Equipment, for example, a printer or a projector.

DT_MAILUSER

((ULONG) 0x00000000)

User with a mailbox.

DT_REMOTE_MAILUSER

((ULONG) 0x00000000)

An address list entry in the Global Address List.

DT_ROOM

((ULONG) 0x00000007)

Conference room.

DT_SEC_DISTLIST

((ULONG) 0x00000009)

Security distribution list.

In both a single forest and in a cross-forest configuration, when PR_DISPLAY_TYPE has the value of DT_DISTLIST and DTE_IS_REMOTE_VALID is false, applying the DTE_LOCAL macro to the value of this property can let you obtain the type of the distribution list. The possible types of distribution list are the following:

Type of Distribution List

Value

Description

DT_DISTLIST

((ULONG) 0x00000001)

Distribution list.

DT_SEC_DISTLIST

((ULONG) 0x00000009)

Security distribution list.

Protocol Specifications

  • [MS-OXPROPS]
    Provides references to related Exchange Server protocol specifications.

  • [MS-OXOABK]
    Specifies the properties and operations for lists of users, contacts, groups, and resources.

Header Files

  • Mapidefs.h
    Provides data type definitions.

  • Mapitags.h
    Contains definitions of properties listed as alternate names.

See Also

Concepts

MAPI Properties

MAPI Canonical Properties

Mapping Canonical Property Names to MAPI Names

Mapping MAPI Names to Canonical Property Names