CSVFIELD_TO_STRING
The function converts a data field in CSV data field format that is present as a source string into a value in PLC string format. Double quotation marks in the source string are replaced with simple quotation marks. If the bQM parameter is set (QM = quotation marks) the outer quotation marks (enclosing the data field) are removed from the source string. If successful the function returns the converted string as the result. The function returns an empty string if an error occurred during the conversion, but only if the source string was not an empty string.
The function is usually used together with the function block FB_CSVMemBufferReader in order to read (interpret) data sets that are stored in the PLC memory in CSV format. Before this operation the CSV data sets are usually read from a file into the PLC memory. The source string must not contain binary data. Binary data with the value zero would terminate and truncate the string in the wrong place. To convert data fields with binary data please use the function CSVFIELD_TO_ARG.
Return value
Name | Type | Description |
|---|---|---|
CSFIELD_TO_STRING | T_MaxString |
|
Inputs
VAR_INPUT
in : T_MaxString;
bQM : BOOL;
END_VARName | Type | Description |
|---|---|---|
in | T_MaxString | Source string with a data field in CSV format that is to be converted into a value in PLC string format (type: T_MaxString). |
bQM | BOOL | If this input is TRUE the enclosing quotation marks are removed from the source string. |
bQM | Description | Source string | Result string | CSV-compliant |
|---|---|---|---|---|
FALSE | Source string without enclosing quotation marks should only contain letters and numbers. In this case the source string must not contain any non-printable control characters, quotation marks, semicolons, commas (US CSV format) or binary data. | 'Module_XA5' '123456' '' | 'Module_XA5' '123456' '' | Yes Yes Yes |
'A""""B' | 'A""B' | No | ||
'A""B' | 'A"B' | No | ||
';' | ';' | No | ||
'$R$N' | '$R$N' | No | ||
'AB$00CD' | 'AB' (string was truncated) | No | ||
TRUE | A source string that is not enclosed in quotation marks should not contain any non-printable control characters, quotation marks, semicolons or commas (US CSV format). Binary data are not permitted. | '"Module_XA5"' | 'Module_XA5' | Yes |
'"123456"' | '123456' | Yes |
| |
'""' | '' | Yes |
| |
'"A""""B"' | 'A""B' | Yes |
| |
'"A""B"' | 'A"B' | Yes |
| |
'";"' | ';' | Yes |
| |
'"$R$N"' | '$R$N' | Yes |
| |
'"AB$00CD"' | 'AB' (string was truncated) | No |
|
Example:
PROGRAM MAIN
VAR
s1 : STRING;
s2 : STRING;
END_VARs1 := CSVFIELD_TO_STRING( '"ab_$04_$05_cd-""ALFA""_5"', TRUE );
s2 := CSVFIELD_TO_STRING( 'Module_50', FALSE );
The result:
s1 = 'ab_$04_$05_cd-"ALFA"_5'
s2 = 'Module_50'
Further information can be found here: Example: Writing/reading of a CSV file.
Requirements
Development environment | Target platform | PLC libraries to be integrated (category group) |
|---|---|---|
TwinCAT v3.1.0 | PC or CX (x86, x64, Arm®) | Tc2_Utilities (System) |