Sumex1.net/generalFormRequest/C++ API: IGeneralFormResult::GetFormObject method

API browser of generalFormRequest450 COM module

IGeneralFormResult::GetFormObject method
Retrieves 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".

Restful webservice calling syntax
[POST]	/baseURL/IGeneralFormResult/GetFormObject
[JSON input data]	pIGeneralFormResult:	longValue, //interface address
[JSON result data]	pbstrRequestFormID: pdRequestFormDate: plRequestFormTimestamp: pbStatus:	"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.

C/C++ calling syntax
HRESULT GetFormObject(	BSTR DATE long VARIANT_BOOL	pbstrRequestFormID, pdRequestFormDate, plRequestFormTimestamp, 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.

Calling argument description
[out] BSTR	*pbstrRequestFormID	The form ID is the main software's own identification of the form process. This is one of 3 identifiers that constitute the form object reference.
[out] DATE	*pdRequestFormDate	The form date is the main software's own date of the form process. This is one of 3 identifiers that constitute the form object reference.
[out] long	*plRequestFormTimestamp	This is a UNIX timestamp defined at the moment of the form's infoset generation. This is one of 3 identifiers that form the form 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.