StartListening Method of Client Object (COM-based API)
This method allows you to get notifications about the completion of work by a specified workflow. The doStart parameter starts or stops the receipt of notifications. If the method is repeatedly called for the same workflow with the same value of the doStart parameter (twice "start receipt" or twice "stop receipt"), redundant calls are ignored. You will receive notifications about jobs which are completed between the "start receipt" call and the "stop receipt" call and whose resulting XML files are saved into the Output folder. If you want the resulting XML file to be saved into the Output folder, you must select the Save XML Result file in folder option on the Output tab of the Workflow Properties dialog box.
The IsListening method allows you to learn whether receipt of notifications from a selected workflow is enabled or disabled.
Visual Basic Syntax
Method StartListening(
workflow As String,
doStart As Boolean
)
C++ Syntax
HRESULT StartListening(
BSTR workflow,
VARIANT_BOOL doStart
);
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.
doStart
[in] This variable of the Boolean type starts or stops the receipt of notifications.
Return Values
This method has no specific return values. It returns standard return values of ABBYY FineReader Server Open API functions.
See also
See sample: Samples.
26.03.2024 13:49:49