ffdf_document_r.h
Go to the documentation of this file.
1 
24 #ifndef _FSFDF_DOCUMENT_R_H_
25 #define _FSFDF_DOCUMENT_R_H_
26 
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59 
60 /*******************************************************************************/
61 /* FDF document */
62 /*******************************************************************************/
63 
94 FS_RESULT FSFDF_Doc_Load(FSCRT_FILE fdfFile, FSCRT_DOCUMENT* fdfDoc);
95 
117 FS_RESULT FSFDF_Doc_Close(FSCRT_DOCUMENT fdfDoc);
118 
146 FS_RESULT FSFDF_Doc_GetPDFPath(FSCRT_DOCUMENT fdfDoc, FSCRT_BSTR* pdfPath);
147 
148 /*******************************************************************************/
149 /* FDF annotation */
150 /*******************************************************************************/
184 FS_RESULT FSFDF_Annot_GetCount(FSCRT_DOCUMENT fdfDoc, const FSCRT_BSTR* filter, FS_INT32* count);
185 
224 FS_RESULT FSFDF_Annot_Get(FSCRT_DOCUMENT fdfDoc, const FSCRT_BSTR* filter, FS_INT32 index, FSCRT_ANNOT *fdfAnnot);
225 
251 FS_RESULT FSFDF_Annot_GetPageIndex(FSCRT_ANNOT fdfAnnot, FS_INT32 *pageIndex);
252 
253 #ifdef __cplusplus
254 };
255 #endif
256  /* group FFDFDOCUMENT */
258 
259 #endif /* _FSFDF_DOCUMENT_R_H_ */
260 
FSFDF_Annot_GetCount
FS_RESULT FSFDF_Annot_GetCount(FSCRT_DOCUMENT fdfDoc, const FSCRT_BSTR *filter, FS_INT32 *count)
Count annotations in a FDF document by specific filter.
FS_INT32
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FSFDF_Doc_Load
FS_RESULT FSFDF_Doc_Load(FSCRT_FILE fdfFile, FSCRT_DOCUMENT *fdfDoc)
Load a FDF document.
FSFDF_Annot_GetPageIndex
FS_RESULT FSFDF_Annot_GetPageIndex(FSCRT_ANNOT fdfAnnot, FS_INT32 *pageIndex)
Get the ordinal PDF page index, on which the FDF annotation should appear.
FSCRT_BSTR
Structure for byte string.
Definition: fs_base_r.h:611
FSFDF_Doc_GetPDFPath
FS_RESULT FSFDF_Doc_GetPDFPath(FSCRT_DOCUMENT fdfDoc, FSCRT_BSTR *pdfPath)
Get the path of PDF document from FDF document in UTF-8 string.
FSFDF_Annot_Get
FS_RESULT FSFDF_Annot_Get(FSCRT_DOCUMENT fdfDoc, const FSCRT_BSTR *filter, FS_INT32 index, FSCRT_ANNOT *fdfAnnot)
Get an annotation from FDF document by specific filter and index.
FSFDF_Doc_Close
FS_RESULT FSFDF_Doc_Close(FSCRT_DOCUMENT fdfDoc)
Close a FDF document.
FS_RESULT
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160

Foxit Corporation