docs

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

GetLong

Reads a TOML integer into a Clarion LONG with range checking and a supplied default.

Clarion class declaration

GetLong PROCEDURE(STRING pKeyPath,LONG pDefault,*LONG pValue),LONG

Purpose

Reads a TOML integer into a Clarion LONG with range checking and a supplied default.

Parameters

Parameter Type Description
pKeyPath STRING Dotted or indexed TOML key path.
pDefault LONG Value returned when the TOML key or array element is absent.
pValue *LONG Output variable that receives the requested value.

Return value

Returns ProTOML:OK on success or a negative ProTOML error code. Call GetLastError for readable details.

Example (Clarion)

RefreshMinutes LONG
RetCode        LONG

CODE
RetCode = Toml.GetLong('application.refresh_minutes',5,RefreshMinutes)

Notes

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