API browser of generalFormRequest430 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( YesNoType
BSTR
long
long
VARIANT_BOOL
eForceAcrobat2Run,
*pbstrPDFFile,
*plTotalVars,
*plUndefVars,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[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 *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 *plTotalVars The total number of variables of the PDF form file
[out] long *plUndefVars The number of still undefined variables of the PDF form file.

Note, that this is not necessarily an error condition as some variable are on purpose left empty in the user-driven review process.

[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.