IMAPISupport::DoProgressDialog
Applies to: Outlook 2013 | Outlook 2016
Retrieves a progress object that displays a progress indicator.
HRESULT DoProgressDialog(
ULONG_PTR ulUIParam,
ULONG ulFlags,
LPMAPIPROGRESS FAR * lppProgress
);
Parameters
ulUIParam
[in] A handle to the parent window of the progress indicator.
ulFlags
[in] A bitmask of flags that controls how the progress object should calculate progress. The following flag can be set:
MAPI_TOP_LEVEL
Progress is calculated for a top-level item, such as a parent folder. The progress object should use the values in the IMAPIProgress::Progress method's ulCount and ulTotal parameters — which indicate the current item and the total items in the operation, respectively — to increment the progress indicator for the operation.
lppProgress
[out] A pointer to a pointer to the progress object.
Return value
S_OK
The progress object was successfully retrieved.
Remarks
The IMAPISupport::DoProgressDialog method is implemented for address book and message store provider support objects. These providers call DoProgressDialog to access the MAPI implementation of the IMAPIProgress interface, which calculates the progress information and displays a standard dialog box.
For information about how to use a progress object and the IMAPIProgress interface, see Display a Progress Indicator.