IMAPIProgress::Progress
Hace referencia a: Outlook 2013 | Outlook 2016
Novedades el indicador de progreso con una visualización del progreso a medida que se realiza hacia la finalización de la operación.
HRESULT Progress(
ULONG ulValue,
ULONG ulCount,
ULONG ulTotal
);
Parameters
ulValue
[in] Número que indica el nivel actual de progreso (calculado a partir de los parámetros ulCount y ulTotal o de los parámetros lpulMin e lpulMax del método IMAPIProgress::SetLimits ) entre el límite inferior global y el límite superior global.
ulCount
[in] Número que indica el elemento procesado actualmente en relación con el total.
ulTotal
[in] Número total de elementos que se van a procesar durante la operación.
Valor devuelto
S_OK
El indicador de progreso se actualizó correctamente.
Notas a los implementadores
El parámetro ulValue será igual al valor mínimo global solo al principio de la operación y al valor máximo global solo al finalizar la operación.
Use los parámetros ulCount y ulTotal , si está disponible, para mostrar un mensaje opcional como "5 elementos completados de 10". Si ulCount y ulTotal se establecen en 0, decida si desea cambiar visualmente el indicador de progreso. Algunos proveedores de servicios establecen estos parámetros en 0 para indicar que están procesando un subobjeto cuyo progreso se supervisa en relación con un objeto primario. En esta situación, tiene sentido cambiar la presentación solo cuando el objeto primario notifica el progreso. Algunos proveedores de servicios pasan 0 para estos parámetros cada vez.
Para obtener más información sobre cómo implementar Progress y los otros métodos IMAPIProgress , vea Implementar un indicador de progreso.
Notas para los llamadores
No se requieren los tres parámetros de IMAPIProgress::P rogress . El único parámetro necesario es ulValue, un número que indica el porcentaje de progreso. Si se establece la marca de MAPI_TOP_LEVEL, también puede pasar un recuento de objetos y un total de objetos. Algunas implementaciones usan estos valores para mostrar una frase como "5 elementos completados de 10" con el indicador de progreso.
Si va a copiar todos los mensajes de una sola carpeta, establezca ulTotal en el número total de mensajes que se copian. Si va a copiar una carpeta, establezca ulTotal en el número de subcarpetas de la carpeta. Si la carpeta que se va a copiar no contiene subcarpetas y solo mensajes, establezca ulTotal en 1.
Para obtener más información sobre cómo y cuándo debe realizar llamadas a un objeto de progreso, vea Mostrar un indicador de progreso.
Referencia de MFCMAPI
Para obtener un ejemplo de código de MFCMAPI, vea la siguiente tabla.
| Archivo | Función | Comentario |
|---|---|---|
| MAPIProgress.cpp |
CMAPIProgress::P rogress |
MFCMAPI usa el método IMAPIProgress::P rogress para actualizar la barra de estado MFCMAPI con el porcentaje actual de progreso, calculado a partir de uValue y los valores máximo y mínimo actuales. |
Vea también
MFCMAPI como un ejemplo de código