docs

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

TOML_SetInt

Sets an integer value (LONG) at the specified key path in a loaded TOML document.

Preferred Clarion class method

Applications using the ProTOML template normally call SetLong.

SetLong PROCEDURE(STRING pKeyPath,LONG pValue),LONG

Low-level export contract

Item Value
Export TOML_SetInt
Return type LONG
Calling convention PASCAL, RAW, DLL(1)
Binary name NAME(‘TOML_SetInt’)

Parameters

Parameter Type Description
handle LONG Positive document handle returned by a document-creation or load export.
pKeyPath *CSTRING TOML dotted or indexed key path.
value LONG Scalar value to store.
enableDebug LONG Nonzero enables debug behavior for this call.

Return value / error handling

On failure, read TOML_GetLastErrorCode and TOML_GetLastErrorText immediately. The preferred class method converts that pattern into a class result plus retained LastErrorCode and LastErrorText.

Example (Clarion)

RetCode LONG

CODE
Toml.StartDocument()
RetCode = Toml.SetLong('application.refresh_minutes',15)

Notes

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