Header file for PDF Signature module of Foxit PDF SDK. More...
Go to the source code of this file.
Classes | |
| struct | FSPDF_SIGNATURE |
| Handle type to PDF signature. More... | |
| struct | FSPDF_SIGNATUREHANDLER |
| Structure for Signature Handler. More... | |
| struct | FSPDF_SIGNATUREICONPROVIDER |
| Structure for Signature Icon Provider Handler. More... | |
Macros | |
Macro definitions for PDF Signature State | |
| #define | FSPDF_SIGNATURE_STATE_UNKNOWN 0 |
| Unknown signature. | |
| #define | FSPDF_SIGNATURE_STATE_UNSIGNED 1 |
| Unsigned signature. | |
| #define | FSPDF_SIGNATURE_STATE_VALID 2 |
| Valid signature. | |
| #define | FSPDF_SIGNATURE_STATE_INVALID 3 |
| Invalid signature. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_FOXITFLAG 0x0001 |
| Show Foxit flag on signature appearance. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_LABEL 0x0002 |
| Show label on description. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_REASON 0x0004 |
| Show reason on description. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_DATE 0x0008 |
| Show date on description. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_DN 0x0010 |
| Show dn on description. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_LOCATION 0x0020 |
| Show location on description. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_NAME 0x0040 |
| Show signer name on description. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_IMAGE 0x0080 |
| Show image on signature appearance. | |
| #define | FSPDF_SIGNATURE_APPEARANCE_TEXT 0x0100 |
| Show text on signature appearance. | |
Macro definitions for PDF Signature State Icon Fit Mode | |
| #define | FSPDF_SIGNATURE_ICONFITMODE_NORMAL 0 |
| Icon fit mode: normal. More... | |
| #define | FSPDF_SIGNATURE_ICONFITMODE_FITFIELD 1 |
| Icon fit mode: fit field. More... | |
Functions | |
| FS_RESULT | FSPDF_Signature_RegisterHandler (const FSCRT_BSTR *filter, const FSCRT_BSTR *subFilter, FSPDF_SIGNATUREHANDLER *sigHandler) |
| A third-party handler registers their handler to Foxit PDF SDK, along with its filter and sub filter. More... | |
| FS_RESULT | FSPDF_Signature_SetIconProvider (FSPDF_SIGNATUREICONPROVIDER *iconProvider) |
| Set signature icon provider to Foxit PDF SDK. More... | |
| FS_RESULT | FSPDF_Doc_CountSignatures (FSCRT_DOCUMENT doc, FS_INT32 *count) |
| Get signature count in a PDF document. More... | |
| FS_RESULT | FSPDF_Doc_GetSignature (FSCRT_DOCUMENT doc, FS_INT32 index, FSPDF_SIGNATURE *sig) |
| Get a signature object. More... | |
| FS_RESULT | FSPDF_Signature_GetAtPos (FSCRT_PAGE page, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSPDF_SIGNATURE *sig) |
| Get a signature object by a specific position in PDF page. More... | |
| FS_RESULT | FSPDF_Signature_GetDoc (FSPDF_SIGNATURE sig, FSCRT_DOCUMENT *doc) |
| Retrieve the PDF document object related to a specific signature. More... | |
| FS_RESULT | FSPDF_Signature_GetPageIndex (FSPDF_SIGNATURE sig, FS_INT32 *pageIndex) |
| Get the index of a PDF page containing the specified signature. More... | |
| FS_RESULT | FSPDF_Signature_GetFlags (FSPDF_SIGNATURE sig, FS_DWORD *flags) |
| Get annotation flags of a signature. More... | |
| FS_RESULT | FSPDF_Signature_GetFilter (FSPDF_SIGNATURE sig, FSCRT_BSTR *filter) |
| Get the name of the preferred signature handler. More... | |
| FS_RESULT | FSPDF_Signature_GetSubFilter (FSPDF_SIGNATURE sig, FSCRT_BSTR *subFilter) |
| Get sub filter of a signature. More... | |
| FS_RESULT | FSPDF_Signature_GetSigner (FSPDF_SIGNATURE sig, FSCRT_BSTR *signer) |
| Get signer name of a signature. More... | |
| FS_RESULT | FSPDF_Signature_GetDateTime (FSPDF_SIGNATURE sig, FSCRT_DATETIMEZONE *dt) |
| Get signing time of a signature(M entry in the dictionary). More... | |
| FS_RESULT | FSPDF_Signature_GetLocation (FSPDF_SIGNATURE sig, FSCRT_BSTR *location) |
| Get location information of signature owner(Location entry in the dictionary). More... | |
| FS_RESULT | FSPDF_Signature_GetReason (FSPDF_SIGNATURE sig, FSCRT_BSTR *reason) |
| Get signing reason of a signature. More... | |
| FS_RESULT | FSPDF_Signature_GetContactInfo (FSPDF_SIGNATURE sig, FSCRT_BSTR *contactInfo) |
| Get contact information of a signature. More... | |
| FS_RESULT | FSPDF_Signature_GetDistinguishedName (FSPDF_SIGNATURE sig, FSCRT_BSTR *dn) |
| Get distinguished name of the signature owner. More... | |
| FS_RESULT | FSPDF_Signature_GetText (FSPDF_SIGNATURE sig, FSCRT_BSTR *text) |
| Get the text content out of signature appearance. More... | |
| FS_RESULT | FSPDF_Signature_GetBitmap (FSPDF_SIGNATURE sig, FSCRT_BITMAP *bitmap) |
| Get the icon bitmap in signature visual display. More... | |
| FS_RESULT | FSPDF_Signature_GetAppearanceFlags (FSPDF_SIGNATURE sig, FS_DWORD *apFlags) |
| Get signature appearance flags. More... | |
| FS_RESULT | FSPDF_Signature_CountCerts (FSPDF_SIGNATURE sig, FS_INT32 *certCount) |
| Count of certificates in the dictionary's certificate chain. More... | |
| FS_RESULT | FSPDF_Signature_GetCert (FSPDF_SIGNATURE sig, FS_INT32 index, FSCRT_BSTR *signedCert) |
| Get a signature certificate name from certificate chain. More... | |
| FS_RESULT | FSPDF_Signature_StartVerify (FSPDF_SIGNATURE sig, FSCRT_PROGRESS *verifyProgress) |
| Verify a signature progressively by using a signature signing handler specified by its Filter and SubFilter. More... | |
| FS_RESULT | FSPDF_Signature_GetState (FSPDF_SIGNATURE sig, FS_INT32 *state) |
| Get current state of a signature. More... | |
| FS_RESULT | FSPDF_Signature_IsSigned (FSPDF_SIGNATURE sig, FS_BOOL *isSigned) |
| Determine whether a signature is signed or not. More... | |
| FS_RESULT | FSPDF_RenderContext_DrawSignature (FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, FSPDF_SIGNATURE sig) |
| Render a signature on a render context. More... | |
| FS_RESULT | FSPDF_RenderContext_StartPageSignatures (FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, FSCRT_PAGE page, FSCRT_PROGRESS *renderProgress) |
| Render all signatures of a page on render context. More... | |
Header file for PDF Signature module of Foxit PDF SDK.
Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.
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 access to PDF signature, mainly about "reading" methods..
It contains:
