diff options
Diffstat (limited to 'public/fpdf_flatten.h')
| -rw-r--r-- | public/fpdf_flatten.h | 35 |
1 files changed, 17 insertions, 18 deletions
diff --git a/public/fpdf_flatten.h b/public/fpdf_flatten.h index 0c8322e697..f06a7cf17a 100644 --- a/public/fpdf_flatten.h +++ b/public/fpdf_flatten.h @@ -9,31 +9,30 @@ #include "fpdfview.h" +// Result codes. #define FLATTEN_FAIL 0 // Flatten operation failed. #define FLATTEN_SUCCESS 1 // Flatten operation succeed. -#define FLATTEN_NOTINGTODO 2 // There is nothing can be flatten. - -#ifdef __cplusplus -extern "C" { -#endif +#define FLATTEN_NOTHINGTODO 2 // There is nothing to be flattened. +// Flags. #define FLAT_NORMALDISPLAY 0 #define FLAT_PRINT 1 - //Function: FPDFPage_Flatten - // Flat a pdf page,annotations or form fields will become part of the page contents. - //Parameters: - - // page - Handle to the page. Returned by FPDF_LoadPage function. - // nFlag - the flag for the use of flatten result. Zero for normal display, 1 for print. - //Return value: - // The result flag of the function, See flags above ( FLATTEN_FAIL, FLATTEN_SUCCESS, FLATTEN_NOTINGTODO ). - // - // Comments: Current version all fails return zero. If necessary we will assign different value - // to indicate different fail reason. - // - DLLEXPORT int STDCALL FPDFPage_Flatten( FPDF_PAGE page, int nFlag); +#ifdef __cplusplus +extern "C" { +#endif +// Function: FPDFPage_Flatten +// Make annotations and form fields become part of the page contents itself. +// Parameters: +// page - Handle to the page, as returned by FPDF_LoadPage(). +// nFlag - Intended use of the flattened result: 0 for normal display, 1 for printing. +// Return value: +// Either FLATTEN_FAIL, FLATTEN_SUCCESS, or FLATTEN_NOTHINGTODO (see above). +// Comments: +// Currently, all failures return FLATTEN_FAIL, with no indication for the reason +// for the failure. +DLLEXPORT int STDCALL FPDFPage_Flatten(FPDF_PAGE page, int nFlag); #ifdef __cplusplus } |