docs

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

GetArrayCount

Returns the number of elements in a simple array or array of tables.

Clarion class declaration

GetArrayCount PROCEDURE(STRING pKeyPath,*LONG pCount),LONG

Purpose

Returns the number of elements in a simple array or array of tables.

Parameters

Parameter Type Description
pKeyPath STRING Dotted or indexed TOML key path.
pCount *LONG Receives the number of array elements.

Return value

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

Example (Clarion)

ItemCount LONG
RetCode   LONG

CODE
RetCode = Toml.GetArrayCount('recent_files',ItemCount)

Notes

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