Extract Method (TemplateBasedExtractor)

In This Topic

Execute the process of extracting from the input text stream

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function Extract( _
   ByVal input As Stream, _
   Optional ByVal encoding As Encoding _
) As IExtractionResult

'Usage
 
Dim instance As TemplateBasedExtractor
Dim input As Stream
Dim encoding As Encoding
Dim value As IExtractionResult
 
value = instance.Extract(input, encoding)

public IExtractionResult Extract( 
   Stream input,
   Encoding encoding
)

public:
IExtractionResult^ Extract( 
   Stream^ input,
   Encoding^ encoding
)

Parameters

input: The text stream into the extractor process
encoding: The encoding of the input stream. If the encoding is set to null (default input value), then UTF8 encoding is used

Return Value

Return a IExtractionResult instance containing the extraction results

Exceptions

Exception	Description
System.ArgumentException	The exception that is thrown when one of the arguments provided to a method is not valid.
System.ArgumentNullException	The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

Reference

TemplateBasedExtractor Class
TemplateBasedExtractor Members