summaryrefslogtreecommitdiff
path: root/public/fpdf_formfill.h
diff options
context:
space:
mode:
authorLei Zhang <thestig@chromium.org>2018-01-29 19:01:26 +0000
committerChromium commit bot <commit-bot@chromium.org>2018-01-29 19:01:26 +0000
commitd6e92bd6e874a4709144effc79163ef3c13d4b2e (patch)
treec0d08778d3427dd1e0283166d2d87107fe8f8da4 /public/fpdf_formfill.h
parent2f7a01849e698b3d63e79d7e8bf04a6346fa248e (diff)
downloadpdfium-d6e92bd6e874a4709144effc79163ef3c13d4b2e.tar.xz
Clean up FPDF_GetFormType().
- Update public API documentation. - Fix nits in the implementation. Change-Id: I4c7af07b0ec178a5986f45652663f48491b7d078 Reviewed-on: https://pdfium-review.googlesource.com/24330 Reviewed-by: Ryan Harrison <rharrison@chromium.org> Commit-Queue: Lei Zhang <thestig@chromium.org>
Diffstat (limited to 'public/fpdf_formfill.h')
-rw-r--r--public/fpdf_formfill.h25
1 files changed, 12 insertions, 13 deletions
diff --git a/public/fpdf_formfill.h b/public/fpdf_formfill.h
index c2e2bd515a..81c0ea25ac 100644
--- a/public/fpdf_formfill.h
+++ b/public/fpdf_formfill.h
@@ -14,12 +14,13 @@ typedef void* FPDF_FORMHANDLE;
// These values are return values for a public API, so should not be changed
// other than the count when adding new values.
-#define FORMTYPE_NONE 0 // Document contains no forms
-#define FORMTYPE_ACRO_FORM 1 // Forms are specified using AcroForm spec
-#define FORMTYPE_XFA_FULL 2 // Forms are specified using the entire XFA spec
-#define FORMTYPE_XFA_FOREGROUND \
- 3 // Forms are specified using the XFAF subset of XFA spec
-#define FORMTYPE_COUNT 4 // The number of form types
+#define FORMTYPE_NONE 0 // Document contains no forms
+#define FORMTYPE_ACRO_FORM 1 // Forms are specified using AcroForm spec
+#define FORMTYPE_XFA_FULL 2 // Forms are specified using the entire XFA
+ // spec
+#define FORMTYPE_XFA_FOREGROUND 3 // Forms are specified using the XFAF subset
+ // of XFA spec
+#define FORMTYPE_COUNT 4 // The number of form types
// Exported Functions
#ifdef __cplusplus
@@ -1640,15 +1641,13 @@ FPDF_EXPORT void FPDF_CALLCONV FPDF_FFLRecord(FPDF_FORMHANDLE hHandle,
/**
* Experimental API
* Function: FPDF_GetFormType
- * Returns the type of form contained in the PDF document.
+ * Returns the type of form contained in the PDF document.
* Parameters:
- * document - Handle to document.
- *Returned by FPDF_LoadDocument function.
- * docType - Document type defined as
- *FORMTYPE_xxx.
+ * document - Handle to document.
* Return Value:
- * Integer value representing one of the FORMTYPE_xxx
- *values.
+ * Integer value representing one of the FORMTYPE_ values.
+ * Comments:
+ * If |document| is NULL, then the return value is FORMTYPE_NONE.
**/
FPDF_EXPORT int FPDF_CALLCONV FPDF_GetFormType(FPDF_DOCUMENT document);