ProcessAsync(String,ProcessorComponent,CancellationToken) Method

In This Topic

Processes a document from a file source.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<AsyncStateMachineAttribute(XTractFlow.API.DocumentProcessor/d__26)> 
Public Overloads Function ProcessAsync( _ 
   ByVal filePath As String, _ 
   ByVal component As ProcessorComponent, _ 
   Optional ByVal cancellationToken As CancellationToken _ 
) As Task(Of ProcessorResult)

'Usage
 
Dim instance As DocumentProcessor
Dim filePath As String
Dim component As ProcessorComponent
Dim cancellationToken As CancellationToken
Dim value As Task(Of ProcessorResult)
 
value = instance.ProcessAsync(filePath, component, cancellationToken)

[AsyncStateMachine(XTractFlow.API.DocumentProcessor/d__26)] 
public Task<ProcessorResult> ProcessAsync( 
   string filePath, 
   ProcessorComponent component, 
   CancellationToken cancellationToken 
)

[AsyncStateMachine(XTractFlow.API.DocumentProcessor/d__26)] 
public: 
Task<ProcessorResult^>^ ProcessAsync( 
   String^ filePath, 
   ProcessorComponent^ component, 
   CancellationToken cancellationToken 
)

Parameters

filePath: Specifies the path of the document being processed.
component: A XTractFlow.API.Component.ProcessorComponent object containing the workflow logic for processing.
cancellationToken: An optional System.Threading.CancellationToken object enabling cancellation.

Return Value

A XTractFlow.API.Result.ProcessorResult object containing the processing outcome.

Exceptions

Exception	Description
System.IO.FileNotFoundException

Reference

DocumentProcessor Class
DocumentProcessor Members
Overload List

Send Feedback