docs

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

TOML_Free

Releases a loaded TOML document and frees its associated memory.

Preferred Clarion class method

Applications using the ProTOML template normally call Close.

Close PROCEDURE(),LONG

Low-level export contract

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

Parameters

Parameter Type Description
handle LONG Positive document handle returned by a document-creation or load export.
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
RetCode = Toml.Close()

Notes

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