and fills out a PDF based form system
 IGeneralFormRequestManager::GetXML method |
|||
|---|---|---|---|
|
The GetXML method generates the XML infoset based the currently loaded and reviewed PDF form and the XML generation attributes. The such generated infoset is validated against the XSD schema, and stored as UTF8 XML file in the internal working directory. The full file name to this XML document is returned in the pbstrOutputFile output variable. The XML file must be saved to a different location as all temporary XML files in the working directory are deleted before the COM module shuts down!
The generalFormRequest system does not endorse a paradigm of "completeness" or "100% preset capability". Therefore, the PDF form can only be finalized by a user-driven review process whereas the visualization is done by Acrobat Reader using the preset PDF form. After that review and modification process the final XML can be produced based on the final PDF form. However, the review process is suppressed if and only if neither an empty PDF form template was loaded nor any data was altered between the initial load of the PDF and the XML generation. Note about encryption: an encrypted XML infoset can not be loaded successfully by LoadXML. Therefore, to build a local archive besides encrypted XML infoset call GetXML twice once with the lXMLGenerationAttributes = enGenerateWithoutEncryption |
 |
||
| C/C++ calling syntax |
|||
| HRESULT GetXML( | long
YesNoType BSTR long long VARIANT_BOOL |
lXMLGenerationAttributes,
eForceAcrobat2Run, *pbstrOutputFile, *plValidationError, *plTimestamp, *pbStatus); |
|
| Calling argument description |
|||
| [in] long | lXMLGenerationAttributes | This variable defines which principal parts of the XML generation should not be carried out even if the data for that part are defined. lXMLGenerationAttributes is a 32-bit integer where the possible excludes are values from the XMLGenerationAttributes data type and are ORed together to form the overall command.
This feature is necessary to generate different "flavors" of XML infosets without re-setting input data. For instance, an encrypted XML infoset for the "toEan" entity can be produced and in a second call the XML infoset without encryption and signature (lXMLGenerationAttributes = enGenerateWithoutEncryption | enGenerateWithoutSignature) is requested for a local archive (that can be loaded back later!). |
|
| [in] YesNoType | eForceAcrobat2Run | A Boolean that enforces (enYes) the user-driven review and modification process even if the conditions are not fulfilled. eForceAcrobat2Run=enNo requests the automatic behavior. | |
| [out] BSTR | *pbstrOutputFile | The full file name (path + name) where the XML infoset is stored in UTF-8 mode.
The XML file must be saved to a different location as all temporary XML files in the working directory are deleted before the COM module shuts down! |
|
| [out] long | *plValidationError | lValidationError is filled with the validation error code returned by the MSXML-4 parser. A zero value indicates that the validation was successful. | |
| [out] long | *plTimestamp | The timestamp of the XML document as epoch time (seconds elapsed since 1.1.1970) that is used as timestamp of the topmost object reference from that point on.
If the timestamp for the topmost object reference was already set (e.g. to produce a copy) then this same timestamp is returned. |
|
| [out, retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |
| C/C++ return value |
|||
| S_OK | This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE. | ||
| S_FALSE | This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE. | ||
| E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||