docs

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

GetArrayString

Reads a string element from a simple TOML array.

Clarion class declaration

GetArrayString PROCEDURE(STRING pKeyPath, LONG pIndex, STRING pDefault, *CSTRING pValue),LONG

Purpose

Reads a string element from a simple TOML array.

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 STRING Value returned when the TOML key or array element is absent.
pValue *CSTRING 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)

FileName CSTRING(260)
RetCode  LONG

CODE
RetCode = Toml.GetArrayString('recent_files',0,'',FileName)

Notes

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