IPXC_Document::DeferedDigitalSignFieldPFX Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IPXC_Document::DeferedDigitalSignFieldPFX Method}}
 
{{#customTitle:IPXC_Document::DeferedDigitalSignFieldPFX Method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|DeferedDigitalSignFieldPFX|method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|DeferedDigitalSignFieldPFX|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds a digital signature to the specified signature field if it wasn't signed before. Uses a certificate stored in a PKCS#7 file. Note that the signature will be applied only after the document was saved.
  
 
== Syntax ==
 
== Syntax ==
Line 20: Line 19:
 
== Parameters ==
 
== Parameters ==
 
;sPFXFilename
 
;sPFXFilename
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR that specifies the full path and name of the PKCS#7 file where the signatories certificate is stored. If there is more than one certificate stored within the specified file, the first located will be used.
 
;sPFXPassword
 
;sPFXPassword
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR is used to decrypt and verify the PFX packet from the ''sPFXFilename'' file.  
 
;pField
 
;pField
:[in]  Pointer to [[PXV:IPXC_FormField|IPXC_FormField]].
+
:[in]  Pointer to [[PXV:IPXC_FormField|IPXC_FormField]] containing the unsigned signature field on which the signature will be applied to.
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the [[PXV:PXC_SignDocumentFlags|sign document flags]] that determine how the signature field should appear on the page.
 
;sReason
 
;sReason
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR specifying the reason for signing, such as (I agree...).
 
;sLocation
 
;sLocation
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR specifying the CPU host name or physical location of the signing.
 
;sContactInfo
 
;sContactInfo
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR specifying the information provided by the signatory to enable a recipient to contact the signatory to verify the signature; for example, a phone number.
 
;sImageFile
 
;sImageFile
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR specifying the full path and file name of the image (if any) to be displayed within the signature field.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 00:18, 26 April 2016


Adds a digital signature to the specified signature field if it wasn't signed before. Uses a certificate stored in a PKCS#7 file. Note that the signature will be applied only after the document was saved.

Syntax

HRESULT DeferedDigitalSignFieldPFX([in]  LPWSTR           sPFXFilename,
                                   [in]  LPWSTR           sPFXPassword,
                                   [in]  IPXC_FormField*  pField,
                                   [in]  ULONG            nFlags,
                                   [in]  LPWSTR           sReason,
                                   [in]  LPWSTR           sLocation,
                                   [in]  LPWSTR           sContactInfo,
                                   [in]  LPWSTR           sImageFile);

Parameters

sPFXFilename
[in] Value of LPWSTR that specifies the full path and name of the PKCS#7 file where the signatories certificate is stored. If there is more than one certificate stored within the specified file, the first located will be used.
sPFXPassword
[in] Value of LPWSTR is used to decrypt and verify the PFX packet from the sPFXFilename file.
pField
[in] Pointer to IPXC_FormField containing the unsigned signature field on which the signature will be applied to.
nFlags
[in] Value of ULONG containing the sign document flags that determine how the signature field should appear on the page.
sReason
[in] Value of LPWSTR specifying the reason for signing, such as (I agree...).
sLocation
[in] Value of LPWSTR specifying the CPU host name or physical location of the signing.
sContactInfo
[in] Value of LPWSTR specifying the information provided by the signatory to enable a recipient to contact the signatory to verify the signature; for example, a phone number.
sImageFile
[in] Value of LPWSTR specifying the full path and file name of the image (if any) to be displayed within the signature field.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXC_Document