docs

Home

Getting Started

Browse by Category

Class Methods

Low-Level API

ClearArray

Clears an existing array while preserving its kind. A missing key remains absent.

Clarion class declaration

ClearArray PROCEDURE(STRING pKeyPath),LONG

Purpose

Clears an existing array while preserving its kind. A missing key remains absent.

Parameters

Parameter	Type	Description
pKeyPath	STRING	Dotted or indexed 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
RetCode = Toml.ClearArray('recent_files')

Notes

• The class captures DLL diagnostics immediately and retains them in LastErrorCode and LastErrorText.

Related methods

• GetArrayCount
• AppendString
• WriteQueue

Home

Getting Started

Browse by Category

Class Methods

Low-Level API