FileFetcher
The FileFetcher class is a utility class that partitions a multi-page image file into multiple independent ImageData objects. It inherits from the ImageSourceAdapter class.
Definition
Namespace: Dynamsoft.Utility
Assembly: Dynamsoft.Utility.dll
Inheritance: ImageSourceAdapter -> FileFetcher
public class FileFetcher : ImageSourceAdapter
Methods
| Method | Description |
|---|---|
FileFetcher |
Default constructor and destructor of a FileFetcher object. |
SetFile |
Sets the file using a file path, file bytes or an ImageData object. |
SetPDFReadingParameter |
Sets the parameters for reading PDF files. |
SetPages |
Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. |
HasNextImageToFetch |
Determines whether there are more images left to fetch. |
Dispose |
Releases all resources used by current object. |
FileFetcher
Default constructor and destructor of a FileFetcher object.
FileFetcher()
~FileFetcher()
SetFile
Sets the file using a file path, file bytes or an ImageData object.
int SetFile(string path);
int SetFile(byte[] pFileBytes);
int SetFile(ImageData imageData);
Parameters
[in] path The file path.
[in] pFileBytes The file bytes.
[in] imageData The image data object.
Return Value
Returns an integer value that represents the success or failure of the operation.
| Error Code | Value | Description |
|---|---|---|
| EC_NULL_POINTER | -10002 | The fileBytes you input is null. |
| EC_FILE_NOT_FOUND | -10005 | The file is not found. |
| EC_FILE_TYPE_NOT_SUPPORTED | -10006 | The file type is not supported. |
See Also
SetPDFReadingParameter
Sets the parameters for reading PDF files.
int SetPDFReadingParameter(PDFReadingParameter para)
Parameters
[in] para The parameter object for reading PDF files.
Return Value
Returns an integer value that represents the success or failure of the operation.
| Error Code | Value | Description |
|---|---|---|
| EC_PARAMETER_VALUE_INVALID | -10038 | There exists invalid parameter value in your JSON data. |
See Also
SetPages
Sets the 0-based page indexes of a file (.tiff or .pdf) for barcode searching. By default, there is no restriction on the number of pages that can be decoded in a single file.
int SetPages(int[] pages)
Parameters
[in] pages An integer array containing the page information to be set.
Return Value
Returns an integer value that represents the success or failure of the operation.
HasNextImageToFetch
Determines whether there are more images left to fetch.
override bool HasNextImageToFetch()
Return Value
Returns true if there are more images left to fetch, false otherwise.
Dispose
Releases all resources used by current object.
override void Dispose()
Yes
No