IPXC_AcroForm::Export Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 1: | Line 1: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_AcroForm::Export Method}} | {{#customTitle:IPXC_AcroForm::Export Method}} | ||
| − | {{#parentPage:PXV:IPXC_AcroForm|method}} | + | {{#parentPage:PXV:IPXC_AcroForm|Export Method|method}} |
{{ToReview}} | {{ToReview}} | ||
| Line 10: | Line 10: | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pDest |
: [[PXV:IAFS_Name|IAFS_Name]] object that specifies the file where result of form export should be stored. | : [[PXV:IAFS_Name|IAFS_Name]] object that specifies the file where result of form export should be stored. | ||
| − | ; | + | ;sFormat |
: String value that defines the format of exported file. The possible values are: '''FDF''', '''XFDF''', '''HTML''', '''XML'''. | : String value that defines the format of exported file. The possible values are: '''FDF''', '''XFDF''', '''HTML''', '''XML'''. | ||
| − | ; | + | ;pFieldsList |
: Defines a list of fields that should be exported. If this parameter is ''nullptr'' all fields will be exported and parameter ''bInclude'' will be ignored. | : Defines a list of fields that should be exported. If this parameter is ''nullptr'' all fields will be exported and parameter ''bInclude'' will be ignored. | ||
Otherwise it should be a [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] object of [[PXV:PDFVariantType|PVT_Array]] type. If ''bInclude'' has value of ''VARIANT_FALSE'', that array defines a list of fields that should be excluded from all fields list before exporting. | Otherwise it should be a [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] object of [[PXV:PDFVariantType|PVT_Array]] type. If ''bInclude'' has value of ''VARIANT_FALSE'', that array defines a list of fields that should be excluded from all fields list before exporting. | ||
Otherwise the list contains fields that should be exported. Array should contains [[PXV:IPXC_FormField_PDFObject|PDF objects]] of fields or PDF objects with type ''PVT_String'' that represents name of field. | Otherwise the list contains fields that should be exported. Array should contains [[PXV:IPXC_FormField_PDFObject|PDF objects]] of fields or PDF objects with type ''PVT_String'' that represents name of field. | ||
| − | ; | + | ;bInclude |
| + | :[in] Value of VARIANT_BOOL. | ||
| + | ;nFlags | ||
: Combination of [[PXV:PXC_ExportFormFlags|PXC_ExportFormFlags]] flags that modify export functionality. | : Combination of [[PXV:PXC_ExportFormFlags|PXC_ExportFormFlags]] flags that modify export functionality. | ||
Revision as of 12:20, 22 April 2015
Exports form data to a file of specified format.
Contents
Syntax
HRESULT Export([in] IAFS_Name* pDest, [in] LPWSTR sFormat, [in] IPXS_PDFVariant* pFieldsList, [in] VARIANT_BOOL bInclude, [in] ULONG nFlags);
Parameters
- pDest
- IAFS_Name object that specifies the file where result of form export should be stored.
- sFormat
- String value that defines the format of exported file. The possible values are: FDF, XFDF, HTML, XML.
- pFieldsList
- Defines a list of fields that should be exported. If this parameter is nullptr all fields will be exported and parameter bInclude will be ignored.
Otherwise it should be a IPXS_PDFVariant object of PVT_Array type. If bInclude has value of VARIANT_FALSE, that array defines a list of fields that should be excluded from all fields list before exporting. Otherwise the list contains fields that should be exported. Array should contains PDF objects of fields or PDF objects with type PVT_String that represents name of field.
- bInclude
- [in] Value of VARIANT_BOOL.
- nFlags
- Combination of PXC_ExportFormFlags flags that modify export functionality.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IPXC_AcroForm, IAFS_Name.
