IMAPIProgress::GetMin
Applies to: Office 2010 | Outlook 2010 | Visual Studio
Returns the minimum value in the IMAPIProgress::SetLimits method for which progress information is displayed.
HRESULT GetMin(
ULONG FAR * lpulMin
);
Parameters
- lpulMin
[out] A pointer to the minimum number of items in the operation.
Return Value
- S_OK
The minimum number of items in the operation has been retrieved.
Remarks
The minimum value represents the start of the operation in numeric form. The value can be a global maximum value, used to represent the scope of the entire progress display, or a local value, used to represent only a part of the display.
The value of the flag setting affects whether the progress object understands the minimum value to be local or global. When the MAPI_TOP_LEVEL flag is set, the minimum value is considered to be global and is used to calculate progress for the entire operation. When MAPI_TOP_LEVEL is not set, the minimum value is considered local, and providers use it internally to display progress for lower level subobjects. Progress objects save the local minimum value only to return it to a provider through a GetMin call.
Notes to Implementers
Initialize the minimum value to 1. Service providers can reset this value by calling the IMAPIProgress::SetLimits method. For more information about how to implement GetMin and the other IMAPIProgress methods, see Implementing a Progress Indicator.
For more information about how and when to make calls to a progress object, see How to: Display a Progress Indicator.
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
File |
Function |
Comment |
|---|---|---|
MAPIProgress.cpp |
CMAPIProgress::GetMin |
MFCMAPI uses the IMAPIProgress::GetMin method to get the minimum value for the progress indicator. Returns 1 unless limits have been previously set by calling the IMAPIProgress::SetLimits method. |