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


/images/arrow_right.png IForms::UpdateStatus method space
With the change to an automatic, concurrent and externally running update process this method became a NOOP method.
The statistics arguments are set as 0, eIsRunning = enNo and the status will always be VARIANT_TRUE.

Consequently, it is unnecessary to use/call this method anymore.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IForms/UpdateStatus
[JSON input data] pIForms: longValue,    //interface address
[JSON result data] plDBUpdatesTotal:
plDBUpdatesDone:
plFileUpdatesTotal:
plFileUpdatesDone:
peIsRunning:
pbStatus:		 longValue,
longValue,
longValue,
longValue,
longValue,
booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT UpdateStatus( long
long
long
long
YesNoType
VARIANT_BOOL 		*plDBUpdatesTotal,
*plDBUpdatesDone,
*plFileUpdatesTotal,
*plFileUpdatesDone,
*peIsRunning,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
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.
space
/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.
space