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::SetRefObject method space
Sets the optional depended object reference of type credit, invoice, reminder, MCD, form, or notification for which this form process is actually started.

This reference object forms an 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/SetRefObject
[JSON input data] pIGeneralFormRequest:
eRefObjectType:
bstrRequestID:
dRequestDate:
lRequestTimestamp:		 longValue,    //interface address
longValue,
"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 SetRefObject( ObjectType
BSTR
DATE
long
VARIANT_BOOL 		eRefObjectType,
bstrRequestID,
dRequestDate,
lRequestTimestamp,
*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] ObjectType eRefObjectType The type of the depended object reference.
[in] BSTR bstrRequestID The request ID is the main software's identification of the dependent reference object.

This is one of 3 identifiers that constitute this object reference.
[in] DATE dRequestDate The request date is the main software's date of the dependent reference object.

This is one of 3 identifiers that constitute this object reference.
[in] long lRequestTimestamp This is a UNIX timestamp defined at the moment of the dependent reference object's infoset generation.

This is one of 3 identifiers that constitute this object reference.
[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