Compartilhar via


IControlProgressHandler

Essa interface é um manipulador do lado do cliente que recebe atualizações quando a biblioteca executa uma operação. Em seguida, a biblioteca executa retornos de chamada síncronos para o cliente indicando o progresso da operação. Dependendo da ação do usuário, o código de retorno do cliente instrui a biblioteca a continuar a operação ou cancelá-la. Esse processo permite que a interface do usuário mostre ao usuário o progresso de operações longas, como Salvar. Se o usuário optar por cancelar a operação, a interface do usuário retornará o código correspondente para a biblioteca.

Sintaxe

{
  [id(1), helpstring("OnBegin")] HRESULT OnBegin();
  [id(2), helpstring("OnUpdate")] HRESULT OnUpdate
    ([in] ULONG CurrentValuePercent);
  [id(3), helpstring("OnEnd")] HRESULT OnEnd
    ([in] HRESULT hrResult);
};

Funções

A tabela a seguir descreve as funções que essa interface fornece.

Função Descrição

OnBegin

Instrui a biblioteca a iniciar uma operação.

Onupdate

Instrui a biblioteca a continuar o progresso de uma operação.

OnEnd

Retorna um código status após o fim de uma operação.

Interfaces