PdfImagesExtractorExtractImagesAsync(Stream, Int32, CancellationToken) Method

Asynchronously extracts images from the pages of a PDF document in a stream to image objects starting at a given page number through the end of the document

Definition

Namespace: HiQPdf.Next
Assembly: HiQPdf.Next.PdfProcessor (in HiQPdf.Next.PdfProcessor.dll) Version: 1.0.0
C#
public Task<ExtractedImage[][]> ExtractImagesAsync(
	Stream pdfStream,
	int startPageNumber,
	CancellationToken ct = default
)

Parameters

pdfStream  Stream
Stream containing the PDF document from which to extract images
startPageNumber  Int32
Start page number
ct  CancellationToken  (Optional)
A cancellation token that can be used to cancel the asynchronous operation. When cancellation is requested the task returned by this method will complete by throwing OperationCanceledException as soon as possible

Return Value

TaskExtractedImage
An array of arrays of ExtractedImage objects. Each element in the outer array represents a page in the PDF document and each inner array contains the images extracted from that page. For example, images[1] returns all images extracted from the second page and images[1][2] is the third image from the second page

See Also