The action generates a file of CSV format. File name is given by the parameter
fName. Item delimiter in the CSV file is specified by the parameter
delimiter.
The action success is indicated by the output parameter
retCodeIdent_Int.
Value The value of 0 means
the a successful export,
the value values other than 0
means the are an error.
Depending on the parameter
toExportStruct, the action exports:
- the entire local variable
- the row of local variable
- the column of local variable
CSV file formatThe local variable is saved to the specified CSV file row-by-row (row in a structure presents a row in a CSV file).
Because the CSV file format is not unique defined, the action awaits a delimiter as its second parameter. Delimiter is one character, that is to be used to separate items in the CSV file. Real numbers use the decimal separator '
.'.
If the
key wordkeyword Blok kódu |
---|
language | esl |
---|
theme | Confluence |
---|
|
TIME |
is used, then the CSV file also contains the value time for each item. Time is presented before the item value. CSV file therefore contains the double number of columns.
If the key word keyword UTF8 is used, the action generates a text file with UTF-8 encoding.
If the key word keyword APPEND is used, the action inserts data into CSV file. In case that this file does not exist, it will be created.
Time can be formatted by the mask defined in the
transformation palette - the index is given by parameter
transPalIdx_Int.
If the parameter is not defined or its value is 0, there is used the mask
dd.mm.rrrr hh:mi:ss.
If its value is -1, then values of
Absolute time and
Real types are to be converted according to the settings specified in the
Regional and Language Options of the current user on Windows systems. For different operating systems the value of -1 will be automatically replaced with the value of 0.
The parameter timeZone defines export interpretation of timestamps. In case of empty text, timestamps are exported as local times. In case of defined time zone name (e.g. "Europe/London"), timestamps are exported as local times for given time zone. In case of integer value, timestamps are exported as times with fixed offset from UTC, where given value defines offset in seconds. For historical reasons boolean values are accepted: @FALSE - timestamps are exported as local times, @TRUE - timestamps are exported as times with fixed offset of 3600 seconds (1 hour) from UTC. Usage of boolean value @TRUE is not recommended and generates warning when ESL script is being saved. It is recommended to replace it with integer value.
The CSV delimiter (the parameter delimiter) may be obtained by calling the function %GetCSVDelimiter.