fpdf_async_r.h
Go to the documentation of this file.
1 
27 #ifndef _FSPDF_ASYNC_R_H_
28 #define _FSPDF_ASYNC_R_H_
29 
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58 
59 #ifndef _FSPDF_DEF_MACRO_DOC_LINEARIZED_
60 #define _FSPDF_DEF_MACRO_DOC_LINEARIZED_
61 
67 #define FSPDF_DOC_LINEARIZED_YES 1
68 
69 #define FSPDF_DOC_LINEARIZED_NO 0
70 
71 #define FSPDF_DOC_LINEARIZED_UNKNOW -1
72 
74 #endif //_FSPDF_DEF_MACRO_DOC_LINEARIZED_
75 
76 #ifndef _FSPDF_DEF_STRUCTURE_ASYNCFILEHANDLER_
77 #define _FSPDF_DEF_STRUCTURE_ASYNCFILEHANDLER_
78 
82 typedef struct _FSPDF_ASYNCFILEHANDLER
83 {
90 
103  FS_RESULT (*GetFile)(FS_LPVOID clientData, FSCRT_FILE* file);
104 
119  FS_RESULT (*IsDataAvail)(FS_LPVOID clientData, FS_DWORD offset, FS_DWORD size);
120 
137  FS_RESULT (*AddDownloadHint)(FS_LPVOID clientData, FS_DWORD offset, FS_DWORD size);
138 
140 
141 #endif /* _FSPDF_DEF_STRUCTURE_ASYNCFILEHANDLER_ */
142 
175 FS_RESULT FSPDF_Doc_AsyncLoad(FSPDF_ASYNCFILEHANDLER* asyncFile, const FSCRT_BSTR* password, FSCRT_DOCUMENT* document);
176 
203 FS_RESULT FSPDF_Doc_IsLinearized(FSCRT_DOCUMENT document, FS_INT32* linearizedState);
204 
229 FS_RESULT FSPDF_Doc_GetFirstAvailPageIndex(FSCRT_DOCUMENT document, FS_INT32* pageIndex);
230 
262 FS_RESULT FSPDF_Doc_IsDocAvail(FSCRT_DOCUMENT document, FS_BOOL* isAvail);
263 
298 FS_RESULT FSPDF_Doc_IsPageAvail(FSCRT_DOCUMENT document, FS_INT32 pageIndex, FS_BOOL* isAvail);
299 
331 FS_RESULT FSPDF_Doc_IsFormAvail(FSCRT_DOCUMENT document, FS_BOOL* isAvail);
332 
333 #ifdef __cplusplus
334 };
335 #endif
336  /* group FPDFASYNC */
338 
339 #endif /* _FSPDF_ASYNC_R_H_ */
FS_RESULT FSPDF_Doc_AsyncLoad(FSPDF_ASYNCFILEHANDLER *asyncFile, const FSCRT_BSTR *password, FSCRT_DOCUMENT *document)
Load PDF file in asynchronous mode.
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
Structure for receiving download hints.
Definition: fpdf_async_r.h:82
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_RESULT FSPDF_Doc_IsDocAvail(FSCRT_DOCUMENT document, FS_BOOL *isAvail)
Check whether the document is available.
FS_RESULT FSPDF_Doc_IsPageAvail(FSCRT_DOCUMENT document, FS_INT32 pageIndex, FS_BOOL *isAvail)
Check whether the page is available.
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FS_RESULT FSPDF_Doc_GetFirstAvailPageIndex(FSCRT_DOCUMENT document, FS_INT32 *pageIndex)
Get the page index of first available page in a linearized PDF.
void * FS_LPVOID
A pointer to any types.
Definition: fs_base_r.h:127
FS_LPVOID clientData
User-defined data.
Definition: fpdf_async_r.h:89
Structure for byte string.
Definition: fs_base_r.h:611
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.
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FS_RESULT FSPDF_Doc_IsFormAvail(FSCRT_DOCUMENT document, FS_BOOL *isAvail)
Check whether the form is available.

Foxit Corporation