| Home | Getting Started | Browse by Category | Class Methods | Low-Level API |
ProTOML includes 40 low-level DLL API functions for direct or specialized integrations.
The global template and high-level Clarion wrapper are the normal interface. Most developers use High-Level Methods and do not need this section.
Each API page includes:
| Function | High-level method | Purpose |
|---|---|---|
| TOML_GetLicenseMode | ReadLicenseMode | Returns the current runtime mode: 0 blocked, 1 demo, or 2 licensed. |
| TOML_GetLicenseStatusCode | ReadLicenseStatusCode | Returns the current license status code from the license manager. |
| TOML_InitLicense | InitializeLicense | Initializes the runtime license state. Returns 0 for demo mode, 1 for licensed mode, or -1 if blocked. |
| TOML_Free | Close | Releases a loaded TOML document and frees its associated memory. |
| TOML_Load | LoadFile | Loads a TOML file from disk and returns a handle for use in subsequent ProTOML calls. |
| TOML_LoadFromBuffer | LoadBuffer | Loads TOML from exact-length ANSI or UTF-8 bytes. |
| TOML_LoadFromString | LoadText | Parses a TOML document from an in-memory string buffer and returns a handle for subsequent ProTOML calls. |
| TOML_New | NewDocument | Creates a new empty in-memory TOML document. |
| TOML_Save | SaveFile | Saves a loaded TOML document back to disk. |
| TOML_SaveToBuffer | SaveBuffer | Serializes a document as ANSI or UTF-8 bytes. |
| TOML_SaveToString | SaveText | Serializes a loaded TOML document to a caller-supplied string buffer. |
| TOML_GetString | GetString | Returns a string value from a loaded TOML document. |
| TOML_GetStringBuffer | GetString | Gets a string using exact-length ANSI or UTF-8 buffers. |
| TOML_SetString | SetString | Sets a string value at the specified key path in a loaded TOML document. |
| TOML_SetStringBuffer | SetString | Sets a string using exact-length ANSI or UTF-8 buffers. |
| TOML_GetBool | GetBool | Returns a boolean value from a loaded TOML document as a LONG (1 = true, 0 = false). |
| TOML_GetDouble | GetReal | Returns a double-precision floating-point value for the Clarion REAL boundary. |
| TOML_GetFloat | GetSReal | Returns a single-precision floating-point value for the Clarion SREAL boundary. |
| TOML_GetInt | GetLong | Returns an integer value (LONG) from a loaded TOML document. |
| TOML_SetBool | SetBool | Sets a boolean value at the specified key path in a loaded TOML document. |
| TOML_SetDouble | SetReal | Sets a double-precision floating-point value from a Clarion REAL. |
| TOML_SetFloat | SetSReal | Sets a single-precision floating-point value from a Clarion SREAL. |
| TOML_SetInt | SetLong | Sets an integer value (LONG) at the specified key path in a loaded TOML document. |
| TOML_GetDateTimeCombined | GetDateTimeText | Returns a TOML datetime value into a Clarion SQL DateTime GROUP buffer (STRING(8) OVER structure). |
| TOML_GetDateTimeSeparate | GetDateTimeText | Returns a TOML datetime value as separate Clarion date (LONG) and time (LONG) values. |
| TOML_GetDateTimeString | GetDateTimeText | Returns TOML date or time text while preserving its TOML category and offset. |
| TOML_SetDateTimeCombined | SetDateTimeText | Sets a TOML datetime value from a Clarion SQL DateTime GROUP buffer (STRING(8) OVER structure). |
| TOML_SetDateTimeSeparate | SetDateTimeText | Sets a datetime value using separate Clarion date (LONG) and time (LONG) values. |
| TOML_SetDateTimeString | SetDateTimeText | Sets a TOML local or offset date/time value from TOML literal text. |
| TOML_ArrayAppendString | AppendString | Appends a string to a TOML array and returns the new zero-based index. |
| TOML_ArrayAppendStringBuffer | AppendString | Appends an ANSI or UTF-8 string to a simple TOML array. |
| TOML_ArrayAppendTable | AppendTable | Appends a table row to a TOML array of tables and returns the new zero-based index. |
| TOML_ArrayClear | ClearArray | Clears an existing array while preserving its kind. A missing key remains absent until the first append selects the array kind. |
| TOML_GetArrayCount | GetArrayCount | Returns the number of elements in a TOML array or array-of-tables at the specified key path. |
| TOML_GetArrayInt | GetArrayLong | Returns an integer value from a simple TOML array at the specified index. |
| TOML_GetArrayString | GetArrayString | Returns a string value from a simple TOML array at the specified index. |
| TOML_GetArrayStringBuffer | GetArrayString | Gets a string array element using exact-length ANSI or UTF-8 buffers. |
| TOML_GetLastErrorCode | GetLastError | Returns -1 if the last ProTOML operation failed, or 0 if it succeeded. |
| TOML_GetLastErrorText | GetLastError | Returns the error message from the most recent failed ProTOML operation. |
| TOML_KeyExists | KeyExists | Returns 1 if a key exists at the specified path in a loaded TOML document, 0 if not. |
| Home | Getting Started | Browse by Category | Class Methods | Low-Level API |