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


/images/arrow_right.png IGeneralFormRequest::SetFormObject method space
Sets the form object reference parameters.

The dependent object references form a object reference chain with the form as topmost object reference. The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference".

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/SetFormObject
[JSON input data] pIGeneralFormRequest:
bstrRequestFormID:
dRequestFormDate:
lRequestFormTimestamp:		 longValue,    //interface address
"utf8StringValue",
variantDateValue | "stringISODateValue",
longValue
[JSON result data] pbStatus: 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 SetFormObject( BSTR
DATE
long
VARIANT_BOOL 		bstrRequestFormID,
dRequestFormDate,
lRequestFormTimestamp,
*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
[in] BSTR bstrRequestFormID The form ID is the main software's own identification of the current form process.

This is one of 3 identifiers that constitute the form object reference.
[in] DATE dRequestFormDate The form date is the main software's own date of the current form process.

This is one of 3 identifiers that constitute the form object reference.
[in] long lRequestFormTimestamp This is a UNIX timestamp defined at the moment of the form's infoset generation. Set this variable 0 to indicate the generation of a new form object reference. The IGeneralFormRequestManager::GetXML method will return the timestamp that must be used from that point on as 3rd parameter of the object reference.

This is one of 3 identifiers that constitute the form object reference. The timestamp will be generated once for a certain form object reference and thereafter the timestamp is always referenced
[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