Display Server Folder Sizes Property

Display Server Folder Sizes Property

Displays the sizes of specified folders on the server in the Outlook Folder Size dialog box.

Quick Info

Exposed on: IMsgStore object
Created by: Store provider
Accessed by: Outlook and other clients
Property type: PT_BOOLEAN
Access type: Read/write

Remarks

To provide any of the store functionality, the store provider must implement IMAPIProp and return a valid property tag for any of these properties passed to an IMAPIProp::GetIDsFromNames call. When the property tag for any of these properties is passed to IMAPIProp::GetProps, the store provider must also return the correct property value. Store providers can call HrGetOneProp and HrSetOneProp to get or set these properties.

To retrieve the value of this property, the client should first use IMAPIProp::GetIDsFromNames to obtain the property tag, and then specify this property tag in IMAPIProp::GetProps to get the value. When calling IMAPIProp::GetIDsFromNames, specify the following values for the MAPINAMEID structure pointed at by the input parameter lppPropNames:

lpGuid: PS_PUBLIC_STRINGS
ulKind: MNID_STRING
Kind.lpwstrName: L"urn:schemas-microsoft-com:office:outlook#serverfoldersizes"

This property is supported in Microsoft Office Outlook 2003 Service Pack (SP) 1. If the version of Outlook is earlier than Outlook 2003 SP 1, or if its value is false, Outlook will display only the sizes of folders on the local store. If this property is set on a store that uses Outlook 2003 SP 1, Outlook will query for the size of each specified folder on the server and the local drive.

To query for the folder size on the server, Outlook opens a folder on the store with IMsgStore::OpenEntry, passing the flag MAPI_NO_CACHE, and then it queries for PR_MESSAGE_SIZE_EXTENDED. The store provider should then return the folder size on the server.

To query for the size of a folder on the local drive, Outlook opens the folder without the MAPI_NO_CACHE flag. It then queries for PR_MESSAGE_SIZE_EXTENDED; the store provider should return the size of the specified folder on the local drive.

With this property set, store providers that synchronize store contents to a server can display folder size data on the server in the Outlook Folder Size dialog box. Users can then compare their current server storage usage with server quotas.

See Also

About the Store API

Constants for the Store API

Hide Meeting Update Option Property

How to use the Cached Exchange Mode feature with extended MAPI applications in Outlook 2003

Make Store Type Private Property