Selects whether escape sequences like \n or \x40 should be translated by TFORMer.
- Returns:
- - ErrOk (0) in case of success
- Non-zero if error occurred
- Parameters:
-
[in] | pInstance | The TFORMer-Instance provided by a previous call to TFormer_Init. |
[in] | bOn | Should escape sequences be translated? |
Each escape sequence begins with a leading backslash. The following escape sequences are supported by
TFORMer:
Translated Escape Sequences
Sequence | Character |
\' | Single quotation mark |
\" | Double quotation mark |
\\\ | Backslash |
\b | Backspace |
\f | Form feed |
\n | New line |
\r | Carriage return |
\t | Horizontal tab |
\ddd | Octal sequence (3 digits: ddd) |
\xdd | Hexadecimal sequence (2 digits: dd) |
\udddd | Not implemented in this TFORMer Version. Unicode sequence (4 hex digits: dddd) |
In case of an invalid escape sequence (e.g. \q, \999, \129, \xgg) the backslash is ignored. No error will be raised.
Invalid Escape Sequences
Invalid Escape Sequence in Data | Result |
\q | q |
\999 | 999 |
\609 | 09 |
\xgg | xgg |
\ | Empty string |
- See also:
- TFormer_SetVarValue.