docs

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

GetBool

Reads a TOML Boolean into a Clarion BYTE with a supplied default.

Clarion class declaration

GetBool PROCEDURE(STRING pKeyPath,BYTE pDefault,*BYTE pValue),LONG

Purpose

Reads a TOML Boolean into a Clarion BYTE with a supplied default.

Parameters

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

Return value

Returns a Clarion BYTE result as described above.

Example (Clarion)

AutoSave BYTE
RetCode  LONG

CODE
RetCode = Toml.GetBool('application.auto_save',0,AutoSave)

Notes

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