TOML_GetArrayStringBuffer
Gets a string array element using exact-length ANSI or UTF-8 buffers.
Preferred Clarion class method
Applications using the ProTOML template normally call GetArrayString.
GetArrayString PROCEDURE(STRING pKeyPath, LONG pIndex, STRING pDefault, *CSTRING pValue),LONG
Low-level export contract
| Item |
Value |
| Export |
TOML_GetArrayStringBuffer |
| Return type |
LONG |
| Calling convention |
PASCAL, RAW, DLL(1) |
| Binary name |
NAME(‘TOML_GetArrayStringBuffer’) |
Parameters
| Parameter |
Type |
Description |
| handle |
LONG |
Positive document handle returned by a document-creation or load export. |
| pKeyPath |
LONG |
TOML dotted or indexed key path. |
| keyPathBytes |
LONG |
Exact key-path byte count. |
| index |
LONG |
Zero-based TOML array index. |
| pDefault |
LONG |
Default string or buffer used when the key is absent. |
| defaultBytes |
LONG |
Exact default-value byte count. |
| pOutBuf |
LONG |
Caller-provided output buffer, or zero for the first size-query call. |
| outBufBytes |
LONG |
Size of the output buffer in bytes. |
| encodingCode |
LONG |
0 for ANSI or 1 for strict UTF-8. |
| 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)
FileName CSTRING(260)
RetCode LONG
CODE
RetCode = Toml.GetArrayString('recent_files',0,'',FileName)
Notes
- This function is available for advanced or specialized integrations.
- Applications using the global template should call GetArrayString.
- The complete low-level MAP is supplied in Clarion-Classes/ProTOMLRaw.clw.