OnJobComplete Method of IClientEvents Interface (COM-based API)

This method is implemented on the client side. It is called by the ABBYY FineReader Server COM-based API when some of the methods of the Client object are running. It provides information about completion of the job with the specified ID to the client.

Job ID can be changed during job processing, e.g. if document separation is turned on in the workflow settings. In this case, to receive notifications about job completion, you should first start the receipt of notifications from the corresponding workflow with the help of the StartListening method of the Client object. This workflow must publish XML Result files for processed jobs to the Output folder.

Visual Basic Syntax

Sub OnJobComplete(
    ByVal jobId  As String,
    ByVal result As XmlResult

C++ Syntax

HRESULT OnJobComplete(
    BSTR        jobId,
    IXmlResult* result



[in] This variable contains the job ID.


[in] This variable refers to the XmlResult object that contains the parameters and results of processing a job.


The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).

See also



See samples: Samples.

26.03.2024 13:49:49

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.