ProcessAsync(Stream,ProcessorComponent,CancellationToken) Method

In This Topic

Processes a document sourced from a System.IO.Stream object.

Syntax

Visual Basic
C#
C++/CLI

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

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

[AsyncStateMachine(XTractFlow.API.DocumentProcessor/d__28)] 
public Task<ProcessorResult> ProcessAsync( 
   Stream stream, 
   ProcessorComponent component, 
   CancellationToken cancellationToken 
)

[AsyncStateMachine(XTractFlow.API.DocumentProcessor/d__28)] 
public: 
Task<ProcessorResult^>^ ProcessAsync( 
   Stream^ stream, 
   ProcessorComponent^ component, 
   CancellationToken cancellationToken 
)

Parameters

stream: A System.IO.Stream object holding the document content for processing.
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.ArgumentException

Reference

DocumentProcessor Class
DocumentProcessor Members
Overload List

Send Feedback