PidTagStatus Canonical Property

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Contains a 32-bit bitmask of flags that define folder status.

Associated properties:

PR_STATUS

Identifier:

0x360B

Data type:

PT_LONG

Area:

MAPI container

Remarks

This property for folders is analogous to the PR_MSG_STATUS (PidTagMessageStatus) property for messages. Its flags are provided for the client application only and do not affect the message store. Clients can use or ignore these settings. The client can also define its own values for the client-definable bits of this property.

One or more of the following flags can be set for the bitmask:

  • FLDSTATUS_DELMARKED
    The folder is marked for deletion. The client application sets this flag.

  • FLDSTATUS_HIDDEN
    The folder is hidden.

  • FLDSTATUS_HIGHLIGHTED
    The folder is highlighted, for example, shown in reverse video.

  • FLDSTATUS_TAGGED
    The folder is tagged.

Message store providers set this property on a folder to one or more of these values and clients interpret the status as appropriate for their applications. For example, a client can use the folder status to visually differentiate between folders in a hierarchy table, displaying folders with the same status in the same way. Highlighted folders can be shown in reverse video, tagged folders and folders marked for deletion can be shown with a meaningful icon, and hidden folders can be concealed.

Bits 16 through 31 ("0x10000" through "0x80000000") of this property are available for use by the IPM client application. All other bits are reserved for use by MAPI; those not defined in the preceding list should be initially set to zero and not altered.

Protocol Specifications

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

  • [MS-OXCMSG]
    Handles message and attachment objects.

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