docs

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

What Most Developers Actually Use

ProTOML includes a high-level Clarion wrapper and 40 low-level API functions. Most developers use the wrapper supplied by the global template and never call the API functions directly.

The API remains available when direct or specialized access is needed. Ordinary GROUP, QUEUE, and FILE RECORD declarations can be mapped directly; BINDABLE is not required.

The common workflow

In many cases, this is all you need:

  1. Add the ProTOML global template to the EXE app.
  2. Enter the developer license in the template.
  3. Write the high-level calls needed by the application.
  4. Compile and run the application.

Methods most developers use first

Method Typical use
StartDocument Create a new empty document.
SetString, SetLong, SetBool Store individual settings.
WriteGroup / ReadGroup Store and restore a GROUP.
WriteRecord / ReadRecord Store and restore the current FILE record buffer.
WriteQueue / ReadQueue Store and restore a QUEUE.
SaveMemo / LoadMemo Store the complete document in a MEMO field.
SaveBlob / LoadBlob Store the complete document in a BLOB field.
SaveFile / LoadFile Save and load a .toml file.
GetLastError Read a useful error message.

A typical document

Toml.StartDocument()
Toml.WriteGroup('settings',AppSettings)
Toml.WriteRecord('customer',CustomerFile:Record)
Toml.WriteQueue('contacts',ContactQueue)
Toml.SaveMemo(SettingsFile,STO:TomlMemoIndex)

Start with the simplest successful path first, then use the larger method and API references only when you need more.

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