IMAPIProgress::GetMin
The IMAPIProgress::GetMin
method returns the minimum value in IMAPIProgress::SetLimits for which
progress information is displayed.
Quick Info
See IMAPIProgress
: IUnknown.
HRESULT GetMin(
|
ULONG FAR * lpulMin |
|
|
) |
|
Parameters
lpulMin
[out] Pointer
to the minimum number of items in the operation.
Return Values
S_OK
The minimum
number of items in the operation has been retrieved.
Remarks
The minimum
value represents the beginning 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 flags 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 is used internally by providers 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 IMAPIProgress::SetLimits. For more information about
implementing 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 Displaying
Progress Step by Step.
See Also