KCML_Record_Encode

Purpose

Encode a table row buffer

Definition

DEFSUB 'KCML_Record_Encode(sFmt$, BYREF x$, EnumFnSym AS SYM('KCML_Record_Enum_Prototype)) AS KCML_XLAT_ERR

Parameters

sFmtOutput string encoding, "CP" for current codepage
xTable row buffer. The strings are encoded in place
EnumFnSymSYM of the enumeration function for the DEF RECORD the buffer represents

Return

Zero for success, else a non-zero error code taken from the KCML_XLAT_ERR enumeration

Description

Given a table row and the enumeration function for the record, encode the UTF-8 strings into local encoding. Bad UTF-8 sequences and characters that cannot be represeneted in the local encoding are replaced by '?' characters without error. A bad format will error.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.