IMAPIProgress::GetMin

Artigo
04/04/2023

Aplica-se a: Outlook 2013 | Outlook 2016

Retorna o valor mínimo no método IMAPIProgress::SetLimits cujas informações do progresso são exibidas.

HRESULT GetMin(
  ULONG FAR * lpulMin
);

Parâmetros

lpulMin

[out] Um ponteiro para o número mínimo de itens na operação.

Valor de retorno

S_OK

O número mínimo de itens na operação foi recuperado.

Comentários

O valor mínimo representa o início da operação em formato numérico. O valor pode ser um valor máximo global, usado para representar o escopo de toda a exibição do progresso, ou um valor local, usado para representar apenas uma parte da exibição.

O valor da configuração do sinalizador afeta se o objeto de progresso entende o valor mínimo como local ou global. Quando o sinalizador MAPI_TOP_LEVEL estiver definido, o valor mínimo será considerado como global e usado para calcular o progresso de toda a operação. Quando MAPI_TOP_LEVEL não estiver definido, o valor mínimo será considerado como local, e os provedores o usam internamente para exibir o progresso de subobjetos de níveis inferiores. Os objetos de progresso salvam o valor mínimo local apenas para retorná-lo a um provedor por meio de uma chamada GetMin.

Observações para implementadores

Inicialize o valor mínimo como 1. Para redefinir esse valor, os provedores de serviços podem chamar o método IMAPIProgress::SetLimits. Para saber mais sobre como implementar GetMin e os outros métodos IMAPIProgress, confira Como implementar um indicador de progresso.

Para saber mais sobre como e quando fazer chamadas para um objeto de progresso, confira o tópico Exibir um indicador de progresso.

Referência do MFCMAPI

Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.

Arquivo	Função	Comentário
MAPIProgress.cpp	CMAPIProgress::GetMin	O MFCMAPI usa o método IMAPIProgress::GetMin para obter o valor mínimo do indicador de progresso. Retorna 1, a menos que os limites tenham sido definidos anteriormente chamando o método IMAPIProgress::SetLimits.