The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest430 COM module
 IForms::StartUpdate method |
|||
|---|---|---|---|
|
Starts an update process in an asynchronous concurrent mode that updates the form structure (given by the forms database) as well as the PDF forms, but not the COM module itself. The update process is started automatically by the COM module if the last update is older than 14 days.
The update process can be started at any time concurrently to the normal processing. The UpdateStatus method can be repeatedly called to get status information about the update progress. |
 |
||
| C/C++ calling syntax |
|||
| HRESULT StartUpdate( | YesNoType
VARIANT_BOOL |
*peUpdateNecessary,
*pbStatus); |
|
| Calling argument description |
|||
| [out] YesNoType | *peUpdateNecessary | Boolean value that denotes if an update was started (enYes) or if the update is unnecessary (enNo). | |
| [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. | ||