docs

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

ReadQueue

Rebuilds an ordinary Clarion QUEUE from a TOML array of tables and clears partial results after a failed load.

Clarion class declaration

ReadQueue PROCEDURE(STRING pArrayPath,*QUEUE pQueue),LONG

Purpose

Rebuilds an ordinary Clarion QUEUE from a TOML array of tables and clears partial results after a failed load.

Parameters

Parameter Type Description
pArrayPath STRING TOML array-of-tables path used for the QUEUE.
pQueue *QUEUE Ordinary Clarion QUEUE instance to rebuild.

Return value

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

Example (Clarion)

Contacts QUEUE
Kind       STRING(20),NAME('contact_type')
Value      STRING(100),NAME('contact_value')
         END
RetCode  LONG

CODE
RetCode = Toml.ReadQueue('contacts',Contacts)

Notes

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