docs

Home Getting Started Browse by Category Class Methods Low-Level API

TOML_GetDouble

Returns a double-precision floating-point value for the Clarion REAL boundary.

Preferred Clarion class method

Applications using the ProTOML template normally call GetReal.

GetReal PROCEDURE(STRING pKeyPath,REAL pDefault,*REAL pValue),LONG

Low-level export contract

Item Value
Export TOML_GetDouble
Return type REAL
Calling convention PASCAL, RAW, DLL(1)
Binary name NAME(‘TOML_GetDouble’)

Parameters

Parameter Type Description
handle LONG Positive document handle returned by a document-creation or load export.
pKeyPath *CSTRING TOML dotted or indexed key path.
defaultVal REAL Default scalar returned when the key or element is absent.
enableDebug LONG Nonzero enables debug behavior for this call.

Return value / error handling

On failure, read TOML_GetLastErrorCode and TOML_GetLastErrorText immediately. The preferred class method converts that pattern into a class result plus retained LastErrorCode and LastErrorText.

Example (Clarion)

CreditLimit REAL
RetCode     LONG

CODE
RetCode = Toml.GetReal('customer.credit_limit',0.0,CreditLimit)

Notes

Home Getting Started Browse by Category Class Methods Low-Level API