IMAPIProgress::GetMax

The IMAPIProgress::GetMax method returns the maximum number of items in the operation for which progress information is displayed.

Quick Info

See IMAPIProgress : IUnknown.

HRESULT GetMax(
  ULONG FAR * lpulMax  
);

Parameters

lpulMax: [out] Pointer to the maximum number of items in the operation.

Return Values

S_OK: The maximum number of items in the operation has been retrieved.

Remarks

The maximum value represents the end 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 maximum value to be local or global. When the MAPI_TOP_LEVEL flag is set, the maximum value is considered to be global and is used to calculate progress for the entire operation. When MAPI_TOP_LEVEL is not set, the maximum value is considered local and is used internally by providers to display progress for lower level subobjects. Progress objects save the local maximum value only to return it to a provider through a GetMax call.

For more information about how and when to make calls to a progress object, see Displaying Progress Step by Step.

Notes to Implementers

Initialize the maximum value to 1000. Service providers can reset this value by calling IMAPIProgress::SetLimits. For more information about implementing GetMax and the other IMAPIProgress methods, see Implementing a Progress Indicator.