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


/images/arrow_right.png IGeneralFormResponse::GetRefObject method space
Retrieves the dependent object reference parameters. In fact this object reference is mirrored from the corresponding form request infoset.

The dependent object references (if supplied in the request) form an object reference chain (e.g. invoice -> form) 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/IGeneralFormResponse/GetRefObject
[JSON input data] pIGeneralFormResponse: longValue,    //interface address
[JSON result data] peRefObjectType:
pbstrRequestID:
pdRequestDate:
plRequestTimestamp:
pbStatus:		 longValue,
"utf8StringValue",
"stringISODateValue",
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 GetRefObject( ObjectType
BSTR
DATE
long
VARIANT_BOOL 		*peRefObjectType,
*pbstrRequestID,
*pdRequestDate,
*plRequestTimestamp,
*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] ObjectType *peRefObjectType The explicitly used type of the dependent object reference - mirrored from the request.
[out] BSTR *pbstrRequestID The request ID is the main software's identification of the dependent object reference - mirrored from the request.

This is one of 3 identifiers that form the dependent object reference.
[out] DATE *pdRequestDate The request date is the main software's date of the dependent object reference - mirrored from the request.

This is one of 3 identifiers that form the dependent object reference.
[out] long *plRequestTimestamp This is a UNIX timestamp defined at the moment of the dependent object reference's infoset generation - mirrored from the request.

This is one of 3 identifiers that form the dependent 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