API browser of generalFormRequest430 COM module


/images/arrow_right.png IGeneralFormResult::GetFirstNumericResult method
Retrieves the first numerical result structure.

VARIANT_FALSE is returned if the end of the numerical result list is reached.

space
 
/images/arrow_right.png 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);
 
/images/arrow_right.png 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
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
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.