docs

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

TOML_ArrayAppendTable

Appends a table row to a TOML array of tables and returns the new zero-based index.

Preferred Clarion class method

Applications using the ProTOML template normally call AppendTable.

AppendTable PROCEDURE(STRING pKeyPath,*LONG pIndex),LONG

Low-level export contract

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

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.
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)

RowIndex LONG
RetCode  LONG

CODE
RetCode = Toml.AppendTable('contacts',RowIndex)

Notes

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