Esse método é implementado no lado do cliente. Ele é chamado pelo ABBYY FineReader Engine por alguns dos métodos do objeto FRDocument. Ele fornece ao cliente informações sobre o percentual aproximado da operação atual (carregamento de imagem, análise, reconhecimento etc.). Sua implementação pode exibir um indicador de progresso, como é feito no ABBYY FineReader.
No Windows, ele também pode processar mensagens do sistema para ajudar a evitar que o aplicativo pareça não responder durante operações longas. Isso pode ser útil em aplicativos com interface do usuário.
HRESULT OnProgress(
IFRDocument* Sender,
int Percentage,
VARIANT_BOOL* Cancel
);
void OnProgress(
IFRDocument Sender,
int Percentage,
ref bool Cancel
);
Sub OnProgress( _
Sender As IFRDocument, _
Percentage As Integer, _
ByRef Cancel As Boolean _
)
Sender
[in] Este parâmetro se refere ao objeto FRDocument que envia notificações.
Percentage
[in] Este parâmetro contém a porcentagem do trabalho concluída até o momento. Ela varia de 0 a 100.
Cancel
[in, out] Você pode definir esta variável como TRUE para indicar que o processo deve ser encerrado. Nesse caso, a função de processamento retorna E_ABORT.
[Somente C++] Se este método retornar um valor diferente de S_OK, isso indica que ocorreu um erro no lado do cliente e, nesse caso, o valor do parâmetro Cancel não será considerado.
A implementação cliente deste método deve garantir que todas as exceções geradas dentro do método sejam capturadas e tratadas, e que nenhuma exceção seja propagada para fora do método. A propagação de uma exceção para fora do método pode levar a resultados imprevisíveis (como o encerramento do programa).
IFRDocumentEvents
FRDocument