GetJobState Method of Client Object (COM-based API)

This method allows you to get information about current state of the specified job in asynchronous mode.

Visual Basic Syntax

Method GetJobState(
   JobId As String,
   ByRef State As JobStateEnum,
   ByRef Progress As Long

C++ Syntax

HRESULT GetJobState(
    BSTR JobId,
    JobStateEnum* State,
    Long* Progress



[in] This parameter contains the job ID. The job ID must be a string returned by the IClient::ProcessFileAsync or IClient::ProcessXMLTicketAsync method.


[out] A pointer to a JobStateEnum variable that specifies current state of the job. Must not be NULL.


[out] A pointer to a Long variable that specifies the job progress in a percent format. Must not be NULL.

Return Values

This method has no specific return values. It returns standard return values of ABBYY FineReader Server Open API functions.

See also



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.