docs

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

TOML_GetLastErrorText

Returns the error message from the most recent failed ProTOML operation.

Preferred Clarion class method

Applications using the ProTOML template normally call GetLastError.

GetLastError PROCEDURE(*CSTRING pErrorText),LONG

Low-level export contract

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

Parameters

Parameter Type Description
pOutBuf *CSTRING Caller-provided output buffer, or zero for the first size-query call.
outBufBytes LONG Size of the output buffer in bytes.

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)

ErrorText CSTRING(2048)
ErrorCode LONG

CODE
ErrorCode = Toml.GetLastError(ErrorText)
IF ErrorCode < 0
  MESSAGE(ErrorText,'ProTOML Error')
END

Notes

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