IPXC_AcroForm::Export Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m
Line 2: Line 2:
 
{{#customTitle:IPXC_AcroForm::Export Method}}
 
{{#customTitle:IPXC_AcroForm::Export Method}}
 
{{#parentPage:PXV:IPXC_AcroForm|Export Method|method}}
 
{{#parentPage:PXV:IPXC_AcroForm|Export Method|method}}
{{ToReview}}
 
  
Exports form data to a file of specified format.
+
 
 +
Exports form data to a specified file format.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;pDest
 
;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 the form export result should be stored.
 
;sFormat
 
;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 the exported file. Possible values are: '''FDF''', '''XFDF''', '''HTML''', '''XML'''.
 
;pFieldsList
 
;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 the 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 the fields that should be exported. Array should contain [[PXV:IPXC_FormField_PDFObject|PDF objects]] of fields or PDF objects with type ''PVT_String'' that represents the field name.
 
;bInclude
 
;bInclude
 
:[in]  Value of VARIANT_BOOL.
 
:[in]  Value of VARIANT_BOOL.
Line 28: Line 28:
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if operation was successful or an error code in other cases.
  
 
== See Also ==
 
== See Also ==
 
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IAFS_Name|IAFS_Name]].
 
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IAFS_Name|IAFS_Name]].

Revision as of 05:19, 13 May 2015


Exports form data to a specified file format.

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 the form export result should be stored.
sFormat
String value that defines the format of the exported file. Possible values are: FDF, XFDF, HTML, XML.
pFieldsList
Defines the 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 the fields that should be exported. Array should contain PDF objects of fields or PDF objects with type PVT_String that represents the field name.

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 an error code in other cases.

See Also

See also IPXC_AcroForm, IAFS_Name.