docs

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

AppendString

Appends a string to a simple TOML array and returns the new zero-based index through an output parameter.

Clarion class declaration

AppendString PROCEDURE(STRING pKeyPath,STRING pValue,*LONG pIndex),LONG

Purpose

Appends a string to a simple TOML array and returns the new zero-based index through an output parameter.

Parameters

Parameter Type Description
pKeyPath STRING Dotted or indexed TOML key path.
pValue STRING Value to write, or output variable that receives the requested value.
pIndex *LONG Zero-based array index, or output LONG that receives the new index.

Return value

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

Example (Clarion)

NewIndex LONG
RetCode  LONG

CODE
RetCode = Toml.AppendString('recent_files','C:\Data\settings.toml',NewIndex)

Notes

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