IsListening Method of Client Object (COM-based API)

This method allows you to learn whether receipt of job completion notifications from a selected workflow is enabled or disabled. The StartListening starts or stops the receipt of notifications. Between the "start receipt" call and the "stop receipt" call of the StartListening method, the IsListening method returns TRUE.

Visual Basic Syntax

Method IsListening(
   workflow As String
) As Boolean

C++ Syntax

HRESULT IsListening(
   BSTR workflow
   VARIANT_BOOL* result
);

Parameters

workflow

[in] This parameter contains the workflow name. The workflow name must be an element of the list returned by the IClient::Workflows property.

result

[out] A pointer to a Boolean variable that specifies whether receipt of job completion notifications from a selected workflow is enabled or disabled. 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

Client,

IClient::StartListening.

See sample: 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.