The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest450 COM module
IGeneralFormResult::GetFirstNumericResult method | |||
---|---|---|---|
Retrieves the first numerical result structure.
VARIANT_FALSE is returned if the end of the numerical result list is reached. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormResult/GetFirstNumericResult | ||
[JSON input data] | pIGeneralFormResult: | longValue, //interface address |
|
[JSON result data] | pbstrStructName: peResultCodeType: pbstrCode: pbstrName: pdDate: pbstrValue: pbstrUnit: pbstrLowerReference: pbstrUpperReference: pbstrRemark: pbStatus: |
"utf8StringValue", longValue, "utf8StringValue", "utf8StringValue", "stringISODateValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", 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 GetFirstNumericResult( | BSTR
ResultCodeType BSTR BSTR DATE BSTR BSTR BSTR BSTR BSTR VARIANT_BOOL |
*pbstrStructName,
*peResultCodeType, *pbstrCode, *pbstrName, *pdDate, *pbstrValue, *pbstrUnit, *pbstrLowerReference, *pbstrUpperReference, *pbstrRemark, *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 | *pbstrStructName | The PDF internal variable name/placeholder onto which the structure was mapped. | |
[out] ResultCodeType | *peResultCodeType | The used coding system in which the result is defined. | |
[out] BSTR | *pbstrCode | The code of the measurement defined in the used coding system. | |
[out] BSTR | *pbstrName | The name of the measurement. | |
[out] DATE | *pdDate | The date of the measurement | |
[out] BSTR | *pbstrValue | The numerical measurement value ASCII formatted - thus the full measurement result consist of eOperator*bstrValue*bstrUnit
Note that the formatting of numerical values in the PDF is cumbersome and partly impossible (no scientific notation available). Furthermore there is no possibility to extracted and propagate such formatting instructions from the PDF via the COM module to the calling software. Consequently, all values of the numerical result structure are supplied ASCII formatted. |
|
[out] BSTR | *pbstrUnit | The unit in which the all values are expressed - thus the full measurement result consist of eOperator*bstrValue*bstrUnit | |
[out] BSTR | *pbstrLowerReference | The lower reference value ASCII formatted of the measurement expressed in the same unit as the value.
An empty string is returned if no lower reference value is defined. |
|
[out] BSTR | *pbstrUpperReference | The upper reference value ASCII formatted of the measurement expressed in the same unit as the value.
An empty string is returned if no upper reference value is defined. |
|
[out] BSTR | *pbstrRemark | An optional remark. | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |