IPXC_Document::DeferedDigitalPFX2 Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
Line 3: | Line 3: | ||
{{#customTitle:IPXC_Document::DeferedDigitalPFX2 Method}} | {{#customTitle:IPXC_Document::DeferedDigitalPFX2 Method}} | ||
{{#parentPage:PXV:IPXC_Document#Methods|DeferedDigitalPFX2|method}} | {{#parentPage:PXV:IPXC_Document#Methods|DeferedDigitalPFX2|method}} | ||
− | |||
{{ToReview}} | {{ToReview}} | ||
− | + | Adds a digital signature to the document, signs and places as required on the specified page. Uses a certificate stored in PKCS#7 format within the specified memory buffer. Note that the signature will be applied only after the document was saved. | |
== Syntax == | == Syntax == | ||
Line 21: | Line 20: | ||
== Parameters == | == Parameters == | ||
;pPFXFileData | ;pPFXFileData | ||
− | :[in] Pointer to [[PXV:IMemBlock|IMemBlock]]. | + | :[in] Pointer to [[PXV:IMemBlock|IMemBlock]] containing a memory buffer where the signatories certificate (in PKCS#7 format) is stored. If there is more than one certificate stored within the specified buffer, 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 ''pPFXFileData'' buffer. |
;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. |
;nPageIdx | ;nPageIdx | ||
− | :[in] Value of ULONG. | + | :[in] Value of ULONG containing the page index on which the signature field should be placed. |
;pRect | ;pRect | ||
− | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]]. | + | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]] specifying the bounding rectangle of the signature field. |
;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 == |
Latest revision as of 23:15, 25 April 2016
Adds a digital signature to the document, signs and places as required on the specified page. Uses a certificate stored in PKCS#7 format within the specified memory buffer. Note that the signature will be applied only after the document was saved.
Syntax
HRESULT DeferedDigitalPFX2([in] IMemBlock* pPFXFileData, [in] LPWSTR sPFXPassword, [in] ULONG nFlags, [in] ULONG nPageIdx, [in] PXC_Rect* pRect, [in] LPWSTR sReason, [in] LPWSTR sLocation, [in] LPWSTR sContactInfo, [in] LPWSTR sImageFile);
Parameters
- pPFXFileData
- [in] Pointer to IMemBlock containing a memory buffer where the signatories certificate (in PKCS#7 format) is stored. If there is more than one certificate stored within the specified buffer, the first located will be used.
- sPFXPassword
- [in] Value of LPWSTR is used to decrypt and verify the PFX packet from the pPFXFileData buffer.
- nFlags
- [in] Value of ULONG containing the sign document flags that determine how the signature field should appear on the page.
- nPageIdx
- [in] Value of ULONG containing the page index on which the signature field should be placed.
- pRect
- [in] Pointer to PXC_Rect specifying the bounding rectangle of the signature field.
- 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.