IMAPIProgress : IUnknown
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Implements a progress object that provides client applications with a progress indicator. A progress indicator is a user-interface display that shows the percentage of completion of an operation, such as copying folders between message stores. MAPI and client applications implement progress objects and service providers use them.
Header file: |
Mapidefs.h |
Exposed by: |
Progress objects |
Implemented by: |
MAPI and client applications |
Called by: |
Service providers |
Interface identifier: |
IID_IMAPIProgress |
Pointer type: |
LPMAPIPROGRESS |
Vtable Order
Updates the progress indicator with a display of the progress as it is made toward completion of the operation. |
|
Returns flag settings from the progress object for the level of operation on which progress information is calculated. |
|
Returns the maximum number of items in the operation for which progress information is displayed. |
|
Returns the minimum value in the SetLimits method for which progress information is displayed. |
|
Sets the lower and upper limits for the number of items in the operation, and the flags that control how progress information is calculated for the operation. |
Remarks
MAPI includes an lpProgress parameter in many of the methods that perform potentially lengthy operations. lpProgress points to a client implementation of a progress object. Clients that implement the IMAPIProgress interface set this parameter to point to their implementation; clients that do not implement IMAPIProgress set the parameter to NULL. To display a progress indicator during processing of the operation, service providers use the progress object supplied by the client, if available, or a MAPI implementation (indicated when lpProgress is set to NULL).
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
Files |
Function |
Comment |
|---|---|---|
MapiProgress.h and MapiProgress.cpp |
Not applicable |
If the IMAPIProgress setting is enabled, MFCMAPI will pass an IMAPIProgress implementation to all functions that MFCMAPI invokes that accept an implementation. |