docs

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

ProTOML High-Level Methods

The ProTOML global template supplies the Toml object used by these methods. These high-level methods are the normal interface for Clarion applications.

Documents and storage

Method Purpose
StartDocument Start a new empty document.
LoadText / SaveText Load or save the complete document as text.
LoadFile / SaveFile Load or save a .toml file.
LoadMemo / SaveMemo Load or save a complete document in a MEMO.
LoadBlob / SaveBlob Load or save a complete document in a BLOB.
Close Close the current document.

Individual values

Method Purpose
SetString / GetString String values.
SetLong / GetLong LONG values.
SetBool / GetBool Boolean values.
SetSReal / GetSReal SREAL values.
SetReal / GetReal REAL values.
SetDateTimeText / GetDateTimeText TOML date/time text.
KeyExists Test whether a key exists.

Clarion structures

Method Purpose
WriteGroup / ReadGroup Store and restore a GROUP.
WriteRecord / ReadRecord Store and restore the current FILE record buffer.
WriteQueue / ReadQueue Store and restore a QUEUE.

Arrays and diagnostics

Method Purpose
AppendString Append a string to an array.
AppendTable Append an array-of-tables row.
ClearArray Clear an array.
GetArrayCount Read an array count.
GetArrayString / GetArrayLong Read array values.
GetLastError Read a useful error message.
SetDebug Enable or disable debug output.

The Low-Level API Reference is available for specialized integrations, but most applications do not need it.

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