Platform SDK: MAPI

PR_STATUS

The PR_STATUS property contains a 32-bit bitmask of flags defining folder status.

Quick Info

Header file: MAPITAGS.H
Must be exposed by: Folder objects
Must be a column in: Hierarchy tables
Identifier: 0x360B
Property type: PT_LONG
Property tag: 0x360B0003

Remarks

The PR_STATUS property for folders is analogous to the PR_MSG_STATUS 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 the PR_STATUS property.

One or more of the following flags can be set for the PR_STATUS 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 a folder's PR_STATUS property 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 videa, 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 PR_STATUS 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 subsequently.

See Also

Folder Properties