docs

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

SetString

Stores a Clarion string at a TOML key path.

Clarion class declaration

SetString PROCEDURE(STRING pKeyPath,STRING pValue),LONG

Purpose

Stores a Clarion string at a TOML key path.

Parameters

Parameter Type Description
pKeyPath STRING Dotted or indexed TOML key path.
pValue STRING Value to store at the specified TOML key path.

Return value

Returns ProTOML:OK on success or a negative ProTOML error code. Call GetLastError for readable details.

Example (Clarion)

RetCode LONG

CODE
Toml.StartDocument()
RetCode = Toml.SetString('application.name','PageSnip')

Notes

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