fpdf_async_r.h File Reference

Header file for PDF Async module of Foxit PDF SDK. More...

Go to the source code of this file.

Classes

struct  FSPDF_ASYNCFILEHANDLER
 Structure for receiving download hints. More...
 

Macros

Macro Definitions for PDF Document Linearized State.
Note
Linearized state indicates whether a PDF document is a linearized file or not.
#define FSPDF_DOC_LINEARIZED_YES   1
 PDF document is a linearized file.
 
#define FSPDF_DOC_LINEARIZED_NO   0
 PDF document is not a linearized file.
 
#define FSPDF_DOC_LINEARIZED_UNKNOW   -1
 Do not know whether PDF document is a linearize file or not.
 

Functions

FS_RESULT FSPDF_Doc_AsyncLoad (FSPDF_ASYNCFILEHANDLER *asyncFile, const FSCRT_BSTR *password, FSCRT_DOCUMENT *document)
 Load PDF file in asynchronous mode. More...
 
FS_RESULT FSPDF_Doc_IsLinearized (FSCRT_DOCUMENT document, FS_INT32 *linearizedState)
 Check if the asynchronous file is a linearized PDF and get the linearized state. More...
 
FS_RESULT FSPDF_Doc_GetFirstAvailPageIndex (FSCRT_DOCUMENT document, FS_INT32 *pageIndex)
 Get the page index of first available page in a linearized PDF. More...
 
FS_RESULT FSPDF_Doc_IsDocAvail (FSCRT_DOCUMENT document, FS_BOOL *isAvail)
 Check whether the document is available. More...
 
FS_RESULT FSPDF_Doc_IsPageAvail (FSCRT_DOCUMENT document, FS_INT32 pageIndex, FS_BOOL *isAvail)
 Check whether the page is available. More...
 
FS_RESULT FSPDF_Doc_IsFormAvail (FSCRT_DOCUMENT document, FS_BOOL *isAvail)
 Check whether the form is available. More...
 

Detailed Description

Header file for PDF Async module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. You cannot distribute any part of Foxit PDF SDK to any third party or general public, unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.

This header file provides asynchronous access to PDF document.
It allows reading and downloading of a PDF file to occur at the same time. For example, an application can display the first page of the document while the other pages are still downloading. It contains:

  • 1. Load, reload document.
  • 2. Get the first page.
  • 3. Check if the document, page or form is available now.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Standard module explicitly.

Foxit Corporation