docs

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

GetArrayLong

Reads an integer element from a simple TOML array into a Clarion LONG.

Clarion class declaration

GetArrayLong PROCEDURE(STRING pKeyPath,LONG pIndex,LONG pDefault,*LONG pValue),LONG

Purpose

Reads an integer element from a simple TOML array into a Clarion LONG.

Parameters

Parameter Type Description
pKeyPath STRING Dotted or indexed TOML key path.
pIndex LONG Zero-based array index, or output LONG that receives the new index.
pDefault LONG Value returned when the TOML key or array element is absent.
pValue *LONG Value to write, or 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)

Value   LONG
RetCode LONG

CODE
RetCode = Toml.GetArrayLong('retry_delays',0,0,Value)

Notes

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