docs

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

GetDateTimeText

Returns the TOML date/time literal text while preserving its TOML category and offset form.

Clarion class declaration

GetDateTimeText PROCEDURE(STRING pKeyPath,*CSTRING pDateTimeText),LONG

Purpose

Returns the TOML date/time literal text while preserving its TOML category and offset form.

Parameters

Parameter Type Description
pKeyPath STRING Dotted or indexed TOML key path.
pDateTimeText *CSTRING TOML date/time literal text or output CSTRING that receives it.

Return value

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

Example (Clarion)

DateTimeText CSTRING(64)
RetCode      LONG

CODE
RetCode = Toml.GetDateTimeText('job.run_at',DateTimeText)

Notes

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