TOML_GetDateTimeString
Returns TOML date or time text while preserving its TOML category and offset.
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_GetDateTimeString |
| Return type |
LONG |
| Calling convention |
PASCAL, RAW, DLL(1) |
| Binary name |
NAME(‘TOML_GetDateTimeString’) |
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. |
| pOutBuf |
*CSTRING |
Caller-provided output buffer, or zero for the first size-query call. |
| outBufBytes |
LONG |
Size of the output buffer in bytes. |
| 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
- This function is available for advanced or specialized integrations.
- Applications using the global template should call GetDateTimeText.
- The complete low-level MAP is supplied in Clarion-Classes/ProTOMLRaw.clw.