IMAPIProgress::GetFlags

Hace referencia a: Outlook 2013 | Outlook 2016

Devuelve la configuración de marca del objeto de progreso para el nivel de operación en el que se calcula la información de progreso.

HRESULT GetFlags(
  ULONG FAR * lpulFlags
);

Parameters

lpulFlags

[out] Máscara de bits de marcas que controla el nivel de operación en el que se calcula la información de progreso. Se puede devolver la siguiente marca:

MAPI_TOP_LEVEL

El progreso se calcula para el objeto de nivel superior, el objeto al que llama el cliente para iniciar la operación. Por ejemplo, el objeto de nivel superior de una operación de copia de carpeta es la carpeta que se está copiando. Cuando no se establece MAPI_TOP_LEVEL, el progreso se calcula para un objeto de nivel inferior o subobjeto. En la operación de copia de carpetas, un objeto de nivel inferior es una de las subcarpetas de la carpeta que se va a copiar.

Valor devuelto

S_OK

El valor flags se devolvió correctamente.

Comentarios

MAPI permite a los proveedores de servicios diferenciar entre objetos de nivel superior y subobjetos con la marca MAPI_TOP_LEVEL para que todos los objetos implicados en una operación puedan usar la misma implementación IMAPIProgress para mostrar el progreso. Esto hace que la pantalla del indicador continúe sin problemas en una sola dirección positiva. Si se establece la marca de MAPI_TOP_LEVEL determina cómo los proveedores de servicios establecen los demás parámetros en llamadas posteriores al objeto de progreso.

El implementador establece inicialmente el valor devuelto por GetFlags y, posteriormente, el proveedor de servicios a través de una llamada al método IMAPIProgress::SetLimits .

Notas a los implementadores

Inicialice siempre la marca para MAPI_TOP_LEVEL y, a continuación, confíe en los proveedores de servicios para borrarla cuando corresponda. Los proveedores de servicios pueden borrar y restablecer la marca llamando al método IMAPIProgress::SetLimits . Para obtener más información sobre cómo implementar GetFlags y los otros métodos IMAPIProgress , vea Implementar un indicador de progreso.

Notas para los llamadores

Al mostrar un indicador de progreso, realice la primera llamada a IMAPIProgress::GetFlags. El valor devuelto debe ser MAPI_TOP_LEVEL, porque todas las implementaciones inicializan el contenido del parámetro lpulFlags en este valor. Para obtener más información sobre la secuencia de 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::GetFlags	MFCMAPI usa el método IMAPIProgress::GetFlags para determinar qué marcas se establecen. Devuelve MAPI_TOP_LEVEL a menos que se hayan establecido marcas mediante el método IMAPIProgress::SetLimits .

Vea también

IMAPIProgress::SetLimits
IMAPIProgress: IUnknownMFCMAPI como ejemplo de código
Mostrar un indicador de progreso
Implementar un indicador de progreso