docs

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

TOML_GetDateTimeCombined

Returns a TOML datetime value into a Clarion SQL DateTime GROUP buffer (STRING(8) OVER structure).

Preferred Clarion class method

Applications using the ProTOML template normally call GetDateTimeText.

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

Low-level export contract

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

Parameters

Parameter Type Description
handle LONG Positive document handle returned by a document-creation or load export.
pKeyPath *CSTRING TOML dotted or indexed key path.
groupBuffer STRING Eight-byte Clarion DATE/TIME group buffer.
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)

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