The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormRequest430 COM module


/images/arrow_right.png IForms::UpdateStatus method
Supplies progress information about a potentially running update process.

An update process either is started with the StartUpdate method or is automatically initiated by the COM module if the last update is older than 14 days.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT UpdateStatus( long
long
long
long
YesNoType
VARIANT_BOOL 		*plDBUpdatesTotal,
*plDBUpdatesDone,
*plFileUpdatesTotal,
*plFileUpdatesDone,
*peIsRunning,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] long *plDBUpdatesTotal The total number updates of the form database that must be accomplished.
[out] long *plDBUpdatesDone The number updates of the form database of already done.
[out] long *plFileUpdatesTotal The total number PDF form files that must be updated.
[out] long *plFileUpdatesDone The number PDF form files that are already updated.
[out] YesNoType *peIsRunning Boolean value that denotes if an update process is currently ongoing (enYes) or not (enNo).

Once eIsRunning=enNo there are no further updates to perform. Therefore, calling UpdateStatus is no longer useful.
[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.