API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequestManager::GetPDF method
The GetPDF method returns the final PDF form.

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 PDF is per definition in final state. 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 request of the PDF.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetPDF( long
BSTR
long
BSTR
VARIANT_BOOL
lGenerationAttributes,
*pbstrPDFFile,
*plDirectSendTimestamp,
*pbstrDirectSendLog,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] long lGenerationAttributes This variable overrules the default behavior of the PDF generation process even if the appropriate data have been defined.

lGenerationAttributes is a 32-bit integer where the possible "commands" are values from the generationAttributes data type 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 "to" entity can be produced and in a second call the XML infoset without encryption (lGenerationAttributes=enGenerateXMLWithoutEncryption) is requested for a local archive (that can be loaded back later!).

Moreover, the downgrade to the lower version is defined by setting the enGenerateDowngradeToV430 bit.

[out] BSTR *pbstrPDFFile The full file name (path + name) where the final PDF form is stored.

The PDF form file must be saved to a different location as all temporary files in the working directory are deleted before the COM module shuts down!

[out] long *plDirectSendTimestamp The timestamp as epoch time (seconds elapsed since 1.1.1970) when the "direct data send" feature on the PDF form was successfully used. The timestamp is set 0 under all other conditions.

This is basically an information for the documentation of the form process management thus allowing to build an quality of service for the form lifetime.

[out] BSTR *pbstrDirectSendLog This is a log excerpt of the "direct send" process.

The log consists of crlf-separated lines with the format:
     date time: text [ERR=n]
where the error is given in an error situation only.

[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.
 
/images/arrow_right.png 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.