fpdf_signature_w.h
Go to the documentation of this file.
1 
25 #ifndef _FSPDF_SIGNATURE_W_H_
26 #define _FSPDF_SIGNATURE_W_H_
27 
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77 
78 /*******************************************************************************/
79 /* PDF signature */
80 /*******************************************************************************/
110 FS_RESULT FSPDF_Signature_Add(FSCRT_PAGE page, const FSCRT_RECTF* rect, FSPDF_SIGNATURE* sig);
111 
137 FS_RESULT FSPDF_Signature_Remove(FSPDF_SIGNATURE sig);
138 
139 /*******************************************************************************/
140 /* Access signature properties */
141 /*******************************************************************************/
166 FS_RESULT FSPDF_Signature_SetFlags(FSPDF_SIGNATURE sig, FS_DWORD flags);
167 
193 FS_RESULT FSPDF_Signature_SetFilter(FSPDF_SIGNATURE sig, const FSCRT_BSTR* filter);
194 
221 FS_RESULT FSPDF_Signature_SetSubFilter(FSPDF_SIGNATURE sig, const FSCRT_BSTR* subFilter);
222 
245 FS_RESULT FSPDF_Signature_SetSigner(FSPDF_SIGNATURE sig, const FSCRT_BSTR* signer);
246 
269 FS_RESULT FSPDF_Signature_SetDateTime(FSPDF_SIGNATURE sig, const FSCRT_DATETIMEZONE* dt);
270 
295 FS_RESULT FSPDF_Signature_SetLocation(FSPDF_SIGNATURE sig, const FSCRT_BSTR* location);
296 
319 FS_RESULT FSPDF_Signature_SetReason(FSPDF_SIGNATURE sig, const FSCRT_BSTR* reason);
320 
345 FS_RESULT FSPDF_Signature_SetContactInfo(FSPDF_SIGNATURE sig, const FSCRT_BSTR* contactInfo);
346 
369 FS_RESULT FSPDF_Signature_SetDistinguishedName(FSPDF_SIGNATURE sig, const FSCRT_BSTR* dn);
370 
393 FS_RESULT FSPDF_Signature_SetText(FSPDF_SIGNATURE sig, const FSCRT_BSTR* text);
394 
419 FS_RESULT FSPDF_Signature_SetBitmap(FSPDF_SIGNATURE sig, FSCRT_BITMAP bitmap);
420 
447 FS_RESULT FSPDF_Signature_SetImage(FSPDF_SIGNATURE sig, FSCRT_IMAGE image);
448 
473 FS_RESULT FSPDF_Signature_SetAppearanceFlags(FSPDF_SIGNATURE sig, FS_DWORD apFlags);
474 
500 FS_RESULT FSPDF_Signature_SetCertChain(FSPDF_SIGNATURE sig, const FSCRT_BSTR* certChain, FS_INT32 certCount);
501 
526 FS_RESULT FSPDF_Signature_ClearData(FSPDF_SIGNATURE sig);
527 
528 /*******************************************************************************/
529 /* Sign */
530 /*******************************************************************************/
555 FS_RESULT FSPDF_Signature_SetDefaultContentsLength(FSPDF_SIGNATURE sig, FS_DWORD contentsLength);
556 
583 FS_RESULT FSPDF_Signature_InitValue(FSPDF_SIGNATURE sig);
584 
621 FS_RESULT FSPDF_Signature_StartSign(FSPDF_SIGNATURE sig, FSCRT_FILE savedFile, FSCRT_PROGRESS* signProgress);
622 
623 /*******************************************************************************/
624 /* Reset appearance of signature */
625 /*******************************************************************************/
649 FS_RESULT FSPDF_Signature_ResetAppearance(FSPDF_SIGNATURE sig);
650 
651 #ifdef __cplusplus
652 };
653 #endif
654  /* group FPDFSIGNATURE */
656 
657 #endif /* _FSPDF_SIGNATURE_W_H_ */
658 
FS_RESULT FSPDF_Signature_SetSigner(FSPDF_SIGNATURE sig, const FSCRT_BSTR *signer)
Set signer name of a signature.
FS_RESULT FSPDF_Signature_ClearData(FSPDF_SIGNATURE sig)
Clear signature data and its appearance.
Structure for rectangle, in float.
Definition: fs_base_r.h:2078
FS_RESULT FSPDF_Signature_SetSubFilter(FSPDF_SIGNATURE sig, const FSCRT_BSTR *subFilter)
Set sub filter of a signature.
FS_RESULT FSPDF_Signature_Add(FSCRT_PAGE page, const FSCRT_RECTF *rect, FSPDF_SIGNATURE *sig)
Add an unsigned signature field without appearance to a specific position in a PDF page...
FS_RESULT FSPDF_Signature_ResetAppearance(FSPDF_SIGNATURE sig)
Reset the appearance of an unsigned signature field.
FS_RESULT FSPDF_Signature_SetReason(FSPDF_SIGNATURE sig, const FSCRT_BSTR *reason)
Set signing reason of a signature.
FS_RESULT FSPDF_Signature_SetImage(FSPDF_SIGNATURE sig, FSCRT_IMAGE image)
Set an image to icon in signature display.
FS_RESULT FSPDF_Signature_Remove(FSPDF_SIGNATURE sig)
Remove a signature.
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FS_RESULT FSPDF_Signature_SetDefaultContentsLength(FSPDF_SIGNATURE sig, FS_DWORD contentsLength)
Set the default length of signature value.
FS_RESULT FSPDF_Signature_SetAppearanceFlags(FSPDF_SIGNATURE sig, FS_DWORD apFlags)
Set signature appearance flags required for resetting appearance.
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_RESULT FSPDF_Signature_InitValue(FSPDF_SIGNATURE sig)
Initialize a signature field.
Structure for date and time.
Definition: fs_base_r.h:2018
FS_RESULT FSPDF_Signature_SetDateTime(FSPDF_SIGNATURE sig, const FSCRT_DATETIMEZONE *dt)
Set the signing time of a signature(M entry in the dictionary).
FS_RESULT FSPDF_Signature_SetCertChain(FSPDF_SIGNATURE sig, const FSCRT_BSTR *certChain, FS_INT32 certCount)
Set a certificate chain into a signature dictionary.
FS_RESULT FSPDF_Signature_SetDistinguishedName(FSPDF_SIGNATURE sig, const FSCRT_BSTR *dn)
Set distinguished name of signer in a signature dictionary.
FS_RESULT FSPDF_Signature_StartSign(FSPDF_SIGNATURE sig, FSCRT_FILE savedFile, FSCRT_PROGRESS *signProgress)
Sign a PDF document progressively by using a signature signing handler specified by its Filter and Su...
FS_RESULT FSPDF_Signature_SetFlags(FSPDF_SIGNATURE sig, FS_DWORD flags)
Set annotation flags of a signature.
FS_RESULT FSPDF_Signature_SetContactInfo(FSPDF_SIGNATURE sig, const FSCRT_BSTR *contactInfo)
Set contact information of a signature.
FS_RESULT FSPDF_Signature_SetBitmap(FSPDF_SIGNATURE sig, FSCRT_BITMAP bitmap)
Set a bitmap to icon in signature display.
Structure for byte string.
Definition: fs_base_r.h:611
FS_RESULT FSPDF_Signature_SetLocation(FSPDF_SIGNATURE sig, const FSCRT_BSTR *location)
The CPU host name or physical location of the signing.
FS_RESULT FSPDF_Signature_SetFilter(FSPDF_SIGNATURE sig, const FSCRT_BSTR *filter)
Set the name of the preferred signature handler to use for signature.
FS_RESULT FSPDF_Signature_SetText(FSPDF_SIGNATURE sig, const FSCRT_BSTR *text)
Set the text content out of signature appearance.
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160

Foxit Corporation